Show Sidebar Hide Sidebar
Edit this page on GitHub

R figure reference

How are Plotly attributes organized?

plotly charts are described declaratively in the call signature of plotly::plot_ly, plotly::add_trace, and plotly::layout. Every aspect of a plotly chart (the colors, the grid-lines, the data, and so on) has a corresponding key in these call signatures. This page contains an extensive list of these attributes.

Plotly's graph description places attributes into two categories: traces (which describe a single series of data in a graph) and layout attributes that apply to the rest of the chart, like the title, xaxis, or annotations).

Here is a simple example of a plotly chart inlined with links to each attribute's reference section. 

library(plotly)

    p <- plot_ly(economics,
                 type = "scatter",        # all "scatter" attributes: https://plot.ly/r/reference/#scatter
                 x = ~date,               # more about scatter's "x": /r/reference/#scatter-x
                 y = ~uempmed,            # more about scatter's "y": /r/reference/#scatter-y
                 name = "unemployment",   # more about scatter's "name": /r/reference/#scatter-name
                 marker = list(           # marker is a named list, valid keys: /r/reference/#scatter-marker
                   color="#264E86"        # more about marker's "color" attribute: /r/reference/#scatter-marker-color
                 )) %>%

      add_trace(x = ~date,                                         # scatter's "x": /r/reference/#scatter-x
                y = ~fitted((loess(uempmed ~ as.numeric(date)))),  # scatter's "y": /r/reference/#scatter-y
                mode = 'lines',                                    # scatter's "y": /r/reference/#scatter-mode
                line = list(                                       # line is a named list, valid keys: /r/reference/#scatter-line
                  color = "#5E88FC",                               # line's "color": /r/reference/#scatter-line-color
                  dash = "dashed"                                  # line's "dash" property: /r/reference/#scatter-line-dash
                )
      ) %>%

      layout(                        # all of layout's properties: /r/reference/#layout
             title = "Unemployment", # layout's title: /r/reference/#layout-title
             xaxis = list(           # layout's xaxis is a named list. List of valid keys: /r/reference/#layout-xaxis
                title = "Time",      # xaxis's title: /r/reference/#layout-xaxis-title
                showgrid = F),       # xaxis's showgrid: /r/reference/#layout-xaxis-showgrid
             yaxis = list(           # layout's yaxis is a named list. List of valid keys: /r/reference/#layout-yaxis
                title = "uidx")     # yaxis's title: /r/reference/#layout-yaxis-title
      )

Search

scatter
A scatter trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scatter"[, ...])
add_trace(p, type="scatter"[, ...])
A scatter trace accepts any of the keys listed below.



  • type ("scatter")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (dataframe column, list, vector)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • stackgroup (string)
    default: ""
    Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if `orientation` is "h"). If blank or omitted this trace will not be stacked. Stacking also turns `fill` on by default, using "tonexty" ("tonextx") if `orientation` is "h" ("v") and sets the default `mode` to "lines" irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.
  • orientation ( enumerated : "v" | "h" )
    Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `FALSE`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.
  • groupnorm ( enumerated : "" | "fraction" | "percent" )
    default: ""
    Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `FALSE`. Sets the normalization for the sum of this `stackgroup`. With "fraction", the value of each trace at each location is divided by the sum of all trace values at that location. "percent" is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set.
  • stackgaps ( enumerated : "infer zero" | "interpolate" )
    default: "infer zero"
    Only relevant when `stackgroup` is used, and only the first `stackgaps` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `FALSE`. Determines how we handle locations at which other traces in this group have data but this one does not. With "infer zero" we insert a zero at these locations. With "interpolate" we linearly interpolate between existing values, and extrapolate a constant beyond the existing values.
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • mode (flaglist string)
    Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".
  • hoveron (flaglist string)
    Any combination of "points", "fills" joined with a "+"
    examples: "points", "fills", "points+fills"
    Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points".
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • shape ( enumerated : "linear" | "spline" | "hv" | "vh" | "hvh" | "vhv" )
      default: "linear"
      Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape).
    • dash (string)
      default: "solid"
      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • simplify (boolean)
      default: TRUE
      Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • cliponaxis (boolean)
    default: TRUE
    Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".
  • fill ( enumerated : "none" | "tozeroy" | "tozerox" | "tonexty" | "tonextx" | "toself" | "tonext" )
    Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • marker
    • symbol ( enumerated or array of enumerateds : "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      default: "circle"
      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
    • opacity (number or array of numbers between or equal to 0 and 1)
      Sets the marker opacity.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • maxdisplayed (number greater than or equal to 0)
      default: 0
      Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.
    • sizeref (number)
      default: 1
      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode ( enumerated : "diameter" | "area" )
      default: "diameter"
      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • line
      • width (number or array of numbers greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • widthsrc
      • colorsrc
    • gradient
      • type ( enumerated or array of enumerateds : "radial" | "horizontal" | "vertical" | "none" )
        default: "none"
        Sets the type of gradient used to fill the markers
      • color (color or array of colors)
        Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.
      • typesrc
      • colorsrc
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • symbolsrc
    • opacitysrc
    • sizesrc
    • colorsrc
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • textposition ( enumerated or array of enumerateds : "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    default: "middle center"
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • textfont
    Sets the text font.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • r (dataframe column, list, vector)
    r coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the radial coordinatesfor legacy polar chart only.
  • t (dataframe column, list, vector)
    t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the angular coordinatesfor legacy polar chart only.
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "percent" | "constant" | "sqrt" | "data" )
      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_y
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "percent" | "constant" | "sqrt" | "data" )
      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • xsrc
  • ysrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc
  • textpositionsrc
  • rsrc
  • tsrc

bar
A bar trace is initialized with plot_ly or add_trace:
plot_ly(df, type="bar"[, ...])
add_trace(p, type="bar"[, ...])
A bar trace accepts any of the keys listed below.



  • type ("bar")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (dataframe column, list, vector)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • textposition ( enumerated or array of enumerateds : "inside" | "outside" | "auto" | "none" )
    default: "none"
    Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside.
  • insidetextanchor ( enumerated : "end" | "middle" | "start" )
    default: "end"
    Determines if texts are kept at center or start/end points in `textposition` "inside" mode.
  • textangle (angle)
    default: auto
    Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars.
  • textfont
    Sets the font used for `text`.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • insidetextfont
    Sets the font used for `text` lying inside the bar.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • outsidetextfont
    Sets the font used for `text` lying outside the bar.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • constraintext ( enumerated : "inside" | "outside" | "both" | "none" )
    default: "both"
    Constrain the size of text inside or outside a bar to be no larger than the bar itself.
  • cliponaxis (boolean)
    default: TRUE
    Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".
  • orientation ( enumerated : "v" | "h" )
    Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).
  • base (number or categorical coordinate string)
    Sets where the bar base is drawn (in position axis units). In "stack" or "relative" barmode, traces that set "base" will be excluded and drawn in "overlay" mode instead.
  • offset (number or array of numbers)
    Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead.
  • width (number or array of numbers greater than or equal to 0)
    Sets the bar width (in position axis units).
  • marker
    • line
      • width (number or array of numbers greater than or equal to 0)
        default: 0
        Sets the width (in px) of the lines bounding the marker points.
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • widthsrc
      • colorsrc
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • opacity (number or array of numbers between or equal to 0 and 1)
      default: 1
      Sets the opacity of the bars.
    • colorsrc
    • opacitysrc
  • offsetgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
  • alignmentgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • r (dataframe column, list, vector)
    r coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the radial coordinatesfor legacy polar chart only.
  • t (dataframe column, list, vector)
    t coordinates in scatter traces are deprecated!Please switch to the "scatterpolar" trace type.Sets the angular coordinatesfor legacy polar chart only.
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "percent" | "constant" | "sqrt" | "data" )
      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_y
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "percent" | "constant" | "sqrt" | "data" )
      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • xsrc
  • ysrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc
  • textpositionsrc
  • basesrc
  • offsetsrc
  • widthsrc
  • rsrc
  • tsrc

box
A box trace is initialized with plot_ly or add_trace:
plot_ly(df, type="box"[, ...])
add_trace(p, type="box"[, ...])
A box trace accepts any of the keys listed below.



  • type ("box")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • y (dataframe column, list, vector)
    Sets the y sample data or coordinates. See overview for more info.
  • x (dataframe column, list, vector)
    Sets the x sample data or coordinates. See overview for more info.
  • x0 (number or categorical coordinate string)
    Sets the x coordinate of the box. See overview for more info.
  • y0 (number or categorical coordinate string)
    Sets the y coordinate of the box. See overview for more info.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • whiskerwidth (number between or equal to 0 and 1)
    default: 0.5
    Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).
  • notched (boolean)
    Determines whether or not notches should be drawn.
  • notchwidth (number between or equal to 0 and 0.5)
    default: 0.25
    Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es).
  • boxpoints ( enumerated : "all" | "outliers" | "suspectedoutliers" | FALSE )
    default: "outliers"
    If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4"Q1-3"Q3 or greater than 4"Q3-3"Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If "FALSE", only the box(es) are shown with no sample points
  • boxmean ( enumerated : TRUE | "sd" | FALSE )
    If "TRUE", the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If "sd" the standard deviation is also drawn.
  • jitter (number between or equal to 0 and 1)
    Sets the amount of jitter in the sample points drawn. If "0", the sample points align along the distribution axis. If "1", the sample points are drawn in a random jitter of width equal to the width of the box(es).
  • pointpos (number between or equal to -2 and 2)
    Sets the position of the sample points in relation to the box(es). If "0", the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes
  • orientation ( enumerated : "v" | "h" )
    Sets the orientation of the box(es). If "v" ("h"), the distribution is visualized along the vertical (horizontal).
  • width (number greater than or equal to 0)
    default: 0
    Sets the width of the box in data coordinate If "0" (default value) the width is automatically selected based on the positions of other box traces in the same subplot.
  • marker
    • outliercolor (color)
      default: "rgba(0, 0, 0, 0)"
      Sets the color of the outlier sample points.
    • symbol ( enumerated : "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      default: "circle"
      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • color (color)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • line
      • color (color)
        default: "#444"
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • width (number greater than or equal to 0)
        default: 0
        Sets the width (in px) of the lines bounding the marker points.
      • outliercolor (color)
        Sets the border line color of the outlier sample points. Defaults to marker.color
      • outlierwidth (number greater than or equal to 0)
        default: 1
        Sets the border line width (in px) of the outlier sample points.
  • line
    • color (color)
      Sets the color of line bounding the box(es).
    • width (number greater than or equal to 0)
      default: 2
      Sets the width (in px) of line bounding the box(es).
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • offsetgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
  • alignmentgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
  • hoveron (flaglist string)
    Any combination of "boxes", "points" joined with a "+"
    examples: "boxes", "points", "boxes+points"
    default: "boxes+points"
    Do the hover effects highlight individual boxes or sample points or both?
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • ysrc
  • xsrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc

heatmap
A heatmap trace is initialized with plot_ly or add_trace:
plot_ly(df, type="heatmap"[, ...])
add_trace(p, type="heatmap"[, ...])
A heatmap trace accepts any of the keys listed below.



  • type ("heatmap")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • z (dataframe column, list, vector)
    Sets the z data.
  • x (dataframe column, list, vector)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (dataframe column, list, vector)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (dataframe column, list, vector)
    Sets the text elements associated with each z value.
  • hovertext (dataframe column, list, vector)
    Same as `text`.
  • transpose (boolean)
    Transposes the z data.
  • xtype ( enumerated : "array" | "scaled" )
    If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided).
  • ytype ( enumerated : "array" | "scaled" )
    If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided)
  • zsmooth ( enumerated : "fast" | "best" | FALSE )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • xgap (number greater than or equal to 0)
    default: 0
    Sets the horizontal gap (in pixels) between bricks.
  • ygap (number greater than or equal to 0)
    default: 0
    Sets the vertical gap (in pixels) between bricks.
  • zhoverformat (string)
    default: ""
    Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • zauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.
  • zmin (number)
    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
  • zmax (number)
    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
  • zmid (number)
    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • zsrc
  • xsrc
  • ysrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc

histogram
A histogram trace is initialized with plot_ly or add_trace:
plot_ly(df, type="histogram"[, ...])
add_trace(p, type="histogram"[, ...])
A histogram trace accepts any of the keys listed below.



  • type ("histogram")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the sample data to be binned on the x axis.
  • y (dataframe column, list, vector)
    Sets the sample data to be binned on the y axis.
  • text (string or array of strings)
    default: ""
    Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • orientation ( enumerated : "v" | "h" )
    Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).
  • histfunc ( enumerated : "count" | "sum" | "avg" | "min" | "max" )
    default: "count"
    Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • histnorm ( enumerated : "" | "percent" | "probability" | "density" | "probability density" )
    default: ""
    Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If "probability density", the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
  • cumulative
    • enabled (boolean)
      If TRUE, display the cumulative distribution by summing the binned values. Use the `direction` and `centralbin` attributes to tune the accumulation method. Note: in this mode, the "density" `histnorm` settings behave the same as their equivalents without "density": "" and "density" both rise to the number of data points, and "probability" and "probability density" both rise to the number of sample points.
    • direction ( enumerated : "increasing" | "decreasing" )
      default: "increasing"
      Only applies if cumulative is enabled. If "increasing" (default) we sum all prior bins, so the result increases from left to right. If "decreasing" we sum later bins so the result decreases from left to right.
    • currentbin ( enumerated : "include" | "exclude" | "half" )
      default: "include"
      Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. "include" is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. "exclude" makes the opposite half-bin bias, and "half" removes it.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.
  • xbins
    • start (number or categorical coordinate string)
      Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.
    • end (number or categorical coordinate string)
      Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
    • size (number or categorical coordinate string)
      Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above.
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.
  • ybins
    • start (number or categorical coordinate string)
      Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.
    • end (number or categorical coordinate string)
      Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
    • size (number or categorical coordinate string)
      Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above.
  • autobinx (boolean)
    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: TRUE` or `FALSE` and will update `xbins` accordingly before deleting `autobinx` from the trace.
  • autobiny (boolean)
    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: TRUE` or `FALSE` and will update `ybins` accordingly before deleting `autobiny` from the trace.
  • bingroup (string)
    default: ""
    Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same "orientation" under `barmode` "stack", "relative" and "group" are forced into the same bingroup, Using `bingroup`, traces under `barmode` "overlay" and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d" trace can share the same `bingroup`
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variable `binNumber` Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • marker
    • line
      • width (number or array of numbers greater than or equal to 0)
        default: 0
        Sets the width (in px) of the lines bounding the marker points.
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • widthsrc
      • colorsrc
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • opacity (number or array of numbers between or equal to 0 and 1)
      default: 1
      Sets the opacity of the bars.
    • colorsrc
    • opacitysrc
  • offsetgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
  • alignmentgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "percent" | "constant" | "sqrt" | "data" )
      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_y
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "percent" | "constant" | "sqrt" | "data" )
      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • xsrc
  • ysrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc

histogram2d
A histogram2d trace is initialized with plot_ly or add_trace:
plot_ly(df, type="histogram2d"[, ...])
add_trace(p, type="histogram2d"[, ...])
A histogram2d trace accepts any of the keys listed below.



  • type ("histogram2d")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the sample data to be binned on the x axis.
  • y (dataframe column, list, vector)
    Sets the sample data to be binned on the y axis.
  • z (dataframe column, list, vector)
    Sets the aggregation data.
  • marker
  • histnorm ( enumerated : "" | "percent" | "probability" | "density" | "probability density" )
    default: ""
    Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If "probability density", the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
  • histfunc ( enumerated : "count" | "sum" | "avg" | "min" | "max" )
    default: "count"
    Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.
  • xbins
    • start (number or categorical coordinate string)
      Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.
    • end (number or categorical coordinate string)
      Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
    • size (number or categorical coordinate string)
      Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.
  • ybins
    • start (number or categorical coordinate string)
      Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.
    • end (number or categorical coordinate string)
      Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
    • size (number or categorical coordinate string)
      Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).
  • autobinx (boolean)
    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: TRUE` or `FALSE` and will update `xbins` accordingly before deleting `autobinx` from the trace.
  • autobiny (boolean)
    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: TRUE` or `FALSE` and will update `ybins` accordingly before deleting `autobiny` from the trace.
  • bingroup (string)
    default: ""
    Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of "1" on two histogram2d traces will make them their x-bins and y-bins match separately.
  • xbingroup (string)
    default: ""
    Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`
  • ybingroup (string)
    default: ""
    Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`
  • xgap (number greater than or equal to 0)
    default: 0
    Sets the horizontal gap (in pixels) between bricks.
  • ygap (number greater than or equal to 0)
    default: 0
    Sets the vertical gap (in pixels) between bricks.
  • zsmooth ( enumerated : "fast" | "best" | FALSE )
    Picks a smoothing algorithm use to smooth `z` data.
  • zhoverformat (string)
    default: ""
    Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variable `z` Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • zauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.
  • zmin (number)
    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
  • zmax (number)
    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
  • zmid (number)
    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • xsrc
  • ysrc
  • zsrc
  • hovertemplatesrc

histogram2dcontour
A histogram2dcontour trace is initialized with plot_ly or add_trace:
plot_ly(df, type="histogram2dcontour"[, ...])
add_trace(p, type="histogram2dcontour"[, ...])
A histogram2dcontour trace accepts any of the keys listed below.



  • type ("histogram2dcontour")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the sample data to be binned on the x axis.
  • y (dataframe column, list, vector)
    Sets the sample data to be binned on the y axis.
  • z (dataframe column, list, vector)
    Sets the aggregation data.
  • marker
  • histnorm ( enumerated : "" | "percent" | "probability" | "density" | "probability density" )
    default: ""
    Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If "density", the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If "probability density", the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).
  • histfunc ( enumerated : "count" | "sum" | "avg" | "min" | "max" )
    default: "count"
    Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.
  • xbins
    • start (number or categorical coordinate string)
      Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.
    • end (number or categorical coordinate string)
      Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
    • size (number or categorical coordinate string)
      Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.
  • ybins
    • start (number or categorical coordinate string)
      Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5.
    • end (number or categorical coordinate string)
      Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.
    • size (number or categorical coordinate string)
      Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M<n>" for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1).
  • autobinx (boolean)
    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: TRUE` or `FALSE` and will update `xbins` accordingly before deleting `autobinx` from the trace.
  • autobiny (boolean)
    Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: TRUE` or `FALSE` and will update `ybins` accordingly before deleting `autobiny` from the trace.
  • bingroup (string)
    default: ""
    Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of "1" on two histogram2d traces will make them their x-bins and y-bins match separately.
  • xbingroup (string)
    default: ""
    Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`
  • ybingroup (string)
    default: ""
    Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`
  • autocontour (boolean)
    default: TRUE
    Determines whether or not the contour level attributes are picked by an algorithm. If "TRUE", the number of contour levels can be set in `ncontours`. If "FALSE", set the contour level attributes in `contours`.
  • ncontours (integer greater than or equal to 1)
    default: 15
    Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is "TRUE" or if `contours.size` is missing.
  • contours
    • type ( enumerated : "levels" | "constraint" )
      default: "levels"
      If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.
    • start (number)
      Sets the starting contour level value. Must be less than `contours.end`
    • end (number)
      Sets the end contour level value. Must be more than `contours.start`
    • size (number greater than or equal to 0)
      Sets the step between each contour level. Must be positive.
    • coloring ( enumerated : "fill" | "heatmap" | "lines" | "none" )
      default: "fill"
      Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each contour level If "heatmap", a heatmap gradient coloring is applied between each contour level. If "lines", coloring is done on the contour lines. If "none", no coloring is applied on this trace.
    • showlines (boolean)
      default: TRUE
      Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill".
    • showlabels (boolean)
      Determines whether to label the contour lines with their values.
    • labelfont
      Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • labelformat (string)
      default: ""
      Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
    • operation ( enumerated : "=" | "<" | ">=" | ">" | "<=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")[" )
      default: "="
      Sets the constraint operation. "=" keeps regions equal to `value` "<" and "<=" keep regions less than `value` ">" and ">=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.
    • value (number or categorical coordinate string)
      default: 0
      Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) "value" is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.
  • line
    • color (color)
      Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: "solid"
      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Sets the amount of smoothing for the contour lines, where "0" corresponds to no smoothing.
  • zhoverformat (string)
    default: ""
    Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variable `z` Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • zauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.
  • zmin (number)
    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
  • zmax (number)
    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
  • zmid (number)
    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    default: TRUE
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • xsrc
  • ysrc
  • zsrc
  • hovertemplatesrc

contour
A contour trace is initialized with plot_ly or add_trace:
plot_ly(df, type="contour"[, ...])
add_trace(p, type="contour"[, ...])
A contour trace accepts any of the keys listed below.



  • type ("contour")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • z (dataframe column, list, vector)
    Sets the z data.
  • x (dataframe column, list, vector)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (dataframe column, list, vector)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (dataframe column, list, vector)
    Sets the text elements associated with each z value.
  • hovertext (dataframe column, list, vector)
    Same as `text`.
  • transpose (boolean)
    Transposes the z data.
  • xtype ( enumerated : "array" | "scaled" )
    If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided).
  • ytype ( enumerated : "array" | "scaled" )
    If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided)
  • zhoverformat (string)
    default: ""
    Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • fillcolor (color)
    Sets the fill color if `contours.type` is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • autocontour (boolean)
    default: TRUE
    Determines whether or not the contour level attributes are picked by an algorithm. If "TRUE", the number of contour levels can be set in `ncontours`. If "FALSE", set the contour level attributes in `contours`.
  • ncontours (integer greater than or equal to 1)
    default: 15
    Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is "TRUE" or if `contours.size` is missing.
  • contours
    • type ( enumerated : "levels" | "constraint" )
      default: "levels"
      If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.
    • start (number)
      Sets the starting contour level value. Must be less than `contours.end`
    • end (number)
      Sets the end contour level value. Must be more than `contours.start`
    • size (number greater than or equal to 0)
      Sets the step between each contour level. Must be positive.
    • coloring ( enumerated : "fill" | "heatmap" | "lines" | "none" )
      default: "fill"
      Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each contour level If "heatmap", a heatmap gradient coloring is applied between each contour level. If "lines", coloring is done on the contour lines. If "none", no coloring is applied on this trace.
    • showlines (boolean)
      default: TRUE
      Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill".
    • showlabels (boolean)
      Determines whether to label the contour lines with their values.
    • labelfont
      Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • labelformat (string)
      default: ""
      Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
    • operation ( enumerated : "=" | "<" | ">=" | ">" | "<=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")[" )
      default: "="
      Sets the constraint operation. "=" keeps regions equal to `value` "<" and "<=" keep regions less than `value` ">" and ">=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.
    • value (number or categorical coordinate string)
      default: 0
      Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) "value" is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.
  • line
    • color (color)
      Sets the color of the contour level. Has no effect if `contours.coloring` is set to "lines".
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: "solid"
      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Sets the amount of smoothing for the contour lines, where "0" corresponds to no smoothing.
  • zauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.
  • zmin (number)
    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
  • zmax (number)
    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
  • zmid (number)
    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • zsrc
  • xsrc
  • ysrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc

scatterternary
A scatterternary trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scatterternary"[, ...])
add_trace(p, type="scatterternary"[, ...])
A scatterternary trace accepts any of the keys listed below.



  • type ("scatterternary")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • a (dataframe column, list, vector)
    Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.
  • b (dataframe column, list, vector)
    Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.
  • c (dataframe column, list, vector)
    Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary<i>.sum`.
  • sum (number greater than or equal to 0)
    default: 0
    The number each triplet should sum to, if only two of `a`, `b`, and `c` are provided. This overrides `ternary<i>.sum` to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary<i>.sum
  • mode (flaglist string)
    Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    default: "markers"
    Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace `hoverinfo` must contain a "text" flag.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: "solid"
      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • shape ( enumerated : "linear" | "spline" )
      default: "linear"
      Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape).
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • cliponaxis (boolean)
    default: TRUE
    Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".
  • fill ( enumerated : "none" | "toself" | "tonext" )
    default: "none"
    Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterternary has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other.
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • marker
    • symbol ( enumerated or array of enumerateds : "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      default: "circle"
      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
    • opacity (number or array of numbers between or equal to 0 and 1)
      Sets the marker opacity.
    • maxdisplayed (number greater than or equal to 0)
      default: 0
      Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode ( enumerated : "diameter" | "area" )
      default: "diameter"
      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • line
      • width (number or array of numbers greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • widthsrc
      • colorsrc
    • gradient
      • type ( enumerated or array of enumerateds : "radial" | "horizontal" | "vertical" | "none" )
        default: "none"
        Sets the type of gradient used to fill the markers
      • color (color or array of colors)
        Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.
      • typesrc
      • colorsrc
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • symbolsrc
    • opacitysrc
    • sizesrc
    • colorsrc
  • textfont
    Sets the text font.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • textposition ( enumerated or array of enumerateds : "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    default: "middle center"
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • hoverinfo (flaglist string)
    Any combination of "a", "b", "c", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "a", "b", "a+b", "a+b+c", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoveron (flaglist string)
    Any combination of "points", "fills" joined with a "+"
    examples: "points", "fills", "points+fills"
    Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points".
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • subplot (subplotid)
    default: ternary
    Sets a reference between this trace's data coordinates and a ternary subplot. If "ternary" (the default value), the data refer to `layout.ternary`. If "ternary2", the data refer to `layout.ternary2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • asrc
  • bsrc
  • csrc
  • textsrc
  • hovertextsrc
  • textpositionsrc
  • hoverinfosrc
  • hovertemplatesrc

violin
A violin trace is initialized with plot_ly or add_trace:
plot_ly(df, type="violin"[, ...])
add_trace(p, type="violin"[, ...])
A violin trace accepts any of the keys listed below.



  • type ("violin")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • y (dataframe column, list, vector)
    Sets the y sample data or coordinates. See overview for more info.
  • x (dataframe column, list, vector)
    Sets the x sample data or coordinates. See overview for more info.
  • x0 (number or categorical coordinate string)
    Sets the x coordinate of the box. See overview for more info.
  • y0 (number or categorical coordinate string)
    Sets the y coordinate of the box. See overview for more info.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute `scalegroup` (please see its description for details).
  • orientation ( enumerated : "v" | "h" )
    Sets the orientation of the violin(s). If "v" ("h"), the distribution is visualized along the vertical (horizontal).
  • bandwidth (number greater than or equal to 0)
    Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb.
  • scalegroup (string)
    default: ""
    If there are multiple violins that should be sized according to to some metric (see `scalemode`), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's `width` is undefined, `scalegroup` will default to the trace's name. In this case, violins with the same names will be linked together
  • scalemode ( enumerated : "width" | "count" )
    default: "width"
    Sets the metric by which the width of each violin is determined."width" means each violin has the same (max) width"count" means the violins are scaled by the number of sample points makingup each violin.
  • spanmode ( enumerated : "soft" | "hard" | "manual" )
    default: "soft"
    Sets the method by which the span in data space where the density function will be computed. "soft" means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. "hard" means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode "manual" and fill in the `span` attribute.
  • span (list)
    Sets the span in data space for which the density function will be computed. Has an effect only when `spanmode` is set to "manual".
  • line
    • color (color)
      Sets the color of line bounding the violin(s).
    • width (number greater than or equal to 0)
      default: 2
      Sets the width (in px) of line bounding the violin(s).
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • points ( enumerated : "all" | "outliers" | "suspectedoutliers" | FALSE )
    default: "outliers"
    If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4"Q1-3"Q3 or greater than 4"Q3-3"Q1 are highlighted (see `outliercolor`) If "all", all sample points are shown If "FALSE", only the violins are shown with no sample points
  • jitter (number between or equal to 0 and 1)
    Sets the amount of jitter in the sample points drawn. If "0", the sample points align along the distribution axis. If "1", the sample points are drawn in a random jitter of width equal to the width of the violins.
  • pointpos (number between or equal to -2 and 2)
    Sets the position of the sample points in relation to the violins. If "0", the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.
  • width (number greater than or equal to 0)
    default: 0
    Sets the width of the violin in data coordinates. If "0" (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.
  • marker
    • outliercolor (color)
      default: "rgba(0, 0, 0, 0)"
      Sets the color of the outlier sample points.
    • symbol ( enumerated : "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      default: "circle"
      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • color (color)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • line
      • color (color)
        default: "#444"
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • width (number greater than or equal to 0)
        default: 0
        Sets the width (in px) of the lines bounding the marker points.
      • outliercolor (color)
        Sets the border line color of the outlier sample points. Defaults to marker.color
      • outlierwidth (number greater than or equal to 0)
        default: 1
        Sets the border line width (in px) of the outlier sample points.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • box
    • visible (boolean)
      Determines if an miniature box plot is drawn inside the violins.
    • width (number between or equal to 0 and 1)
      default: 0.25
      Sets the width of the inner box plots relative to the violins' width. For example, with 1, the inner box plots are as wide as the violins.
    • fillcolor (color)
      Sets the inner box plot fill color.
    • line
      • color (color)
        Sets the inner box plot bounding line color.
      • width (number greater than or equal to 0)
        Sets the inner box plot bounding line width.
  • meanline
    • visible (boolean)
      Determines if a line corresponding to the sample's mean is shown inside the violins. If `box.visible` is turned on, the mean line is drawn inside the inner box. Otherwise, the mean line is drawn from one side of the violin to other.
    • color (color)
      Sets the mean line color.
    • width (number greater than or equal to 0)
      Sets the mean line width.
  • side ( enumerated : "both" | "positive" | "negative" )
    default: "both"
    Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under "overlay" mode, where one trace has `side` set to "positive" and the other to "negative".
  • offsetgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
  • alignmentgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
  • hoveron (flaglist string)
    Any combination of "violins", "points", "kde" joined with a "+" OR "all".
    examples: "violins", "points", "violins+points", "violins+points+kde", "all"
    default: "violins+points+kde"
    Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • ysrc
  • xsrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc

funnel
A funnel trace is initialized with plot_ly or add_trace:
plot_ly(df, type="funnel"[, ...])
add_trace(p, type="funnel"[, ...])
A funnel trace accepts any of the keys listed below.



  • type ("funnel")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (dataframe column, list, vector)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variables `percentInitial`, `percentPrevious` and `percentTotal`. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • hoverinfo (flaglist string)
    Any combination of "name", "x", "y", "text", "percent initial", "percent previous", "percent total" joined with a "+" OR "all" or "none" or "skip".
    examples: "name", "x", "name+x", "name+x+y", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • textinfo (flaglist string)
    Any combination of "label", "text", "percent initial", "percent previous", "percent total", "value" joined with a "+" OR "none".
    examples: "label", "text", "label+text", "label+text+percent initial", "none"
    Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • textposition ( enumerated or array of enumerateds : "inside" | "outside" | "auto" | "none" )
    default: "auto"
    Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside.
  • insidetextanchor ( enumerated : "end" | "middle" | "start" )
    default: "middle"
    Determines if texts are kept at center or start/end points in `textposition` "inside" mode.
  • textangle (angle)
    default: 0
    Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars.
  • textfont
    Sets the font used for `text`.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • insidetextfont
    Sets the font used for `text` lying inside the bar.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • outsidetextfont
    Sets the font used for `text` lying outside the bar.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • constraintext ( enumerated : "inside" | "outside" | "both" | "none" )
    default: "both"
    Constrain the size of text inside or outside a bar to be no larger than the bar itself.
  • cliponaxis (boolean)
    default: TRUE
    Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".
  • orientation ( enumerated : "v" | "h" )
    Sets the orientation of the funnels. With "v" ("h"), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only "y" array is presented or orientation is set to "v". Also regarding graphs including only 'horizontal' funnels, "autorange" on the "y-axis" are set to "reversed".
  • offset (number)
    Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead.
  • width (number greater than or equal to 0)
    Sets the bar width (in position axis units).
  • marker
    • line
      • width (number or array of numbers greater than or equal to 0)
        default: 0
        Sets the width (in px) of the lines bounding the marker points.
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • widthsrc
      • colorsrc
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • opacity (number or array of numbers between or equal to 0 and 1)
      default: 1
      Sets the opacity of the bars.
    • colorsrc
    • opacitysrc
  • connector
    • fillcolor (color)
      Sets the fill color.
    • line
      • color (color)
        default: "#444"
        Sets the line color.
      • width (number greater than or equal to 0)
        default: 0
        Sets the line width (in px).
      • dash (string)
        default: "solid"
        Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • visible (boolean)
      default: TRUE
      Determines if connector regions and lines are drawn.
  • offsetgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
  • alignmentgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • xsrc
  • ysrc
  • hovertextsrc
  • hovertemplatesrc
  • hoverinfosrc
  • textsrc
  • textpositionsrc

waterfall
A waterfall trace is initialized with plot_ly or add_trace:
plot_ly(df, type="waterfall"[, ...])
add_trace(p, type="waterfall"[, ...])
A waterfall trace accepts any of the keys listed below.



  • type ("waterfall")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • measure (dataframe column, list, vector)
    default:
    An array containing types of values. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed.
  • base (number)
    Sets where the bar base is drawn (in position axis units).
  • x (dataframe column, list, vector)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (dataframe column, list, vector)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variables `initial`, `delta` and `final`. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • hoverinfo (flaglist string)
    Any combination of "name", "x", "y", "text", "initial", "delta", "final" joined with a "+" OR "all" or "none" or "skip".
    examples: "name", "x", "name+x", "name+x+y", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • textinfo (flaglist string)
    Any combination of "label", "text", "initial", "delta", "final" joined with a "+" OR "none".
    examples: "label", "text", "label+text", "label+text+initial", "none"
    Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • textposition ( enumerated or array of enumerateds : "inside" | "outside" | "auto" | "none" )
    default: "none"
    Specifies the location of the `text`. "inside" positions `text` inside, next to the bar end (rotated and scaled if needed). "outside" positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. "auto" tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside.
  • insidetextanchor ( enumerated : "end" | "middle" | "start" )
    default: "end"
    Determines if texts are kept at center or start/end points in `textposition` "inside" mode.
  • textangle (angle)
    default: auto
    Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With "auto" the texts may automatically be rotated to fit with the maximum size in bars.
  • textfont
    Sets the font used for `text`.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • insidetextfont
    Sets the font used for `text` lying inside the bar.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • outsidetextfont
    Sets the font used for `text` lying outside the bar.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • constraintext ( enumerated : "inside" | "outside" | "both" | "none" )
    default: "both"
    Constrain the size of text inside or outside a bar to be no larger than the bar itself.
  • cliponaxis (boolean)
    default: TRUE
    Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".
  • orientation ( enumerated : "v" | "h" )
    Sets the orientation of the bars. With "v" ("h"), the value of the each bar spans along the vertical (horizontal).
  • offset (number or array of numbers)
    Shifts the position where the bar is drawn (in position axis units). In "group" barmode, traces that set "offset" will be excluded and drawn in "overlay" mode instead.
  • width (number or array of numbers greater than or equal to 0)
    Sets the bar width (in position axis units).
  • increasing
    • marker
      • color (color)
        Sets the marker color of all increasing values.
      • line
        • color (color)
          Sets the line color of all increasing values.
        • width (number greater than or equal to 0)
          default: 0
          Sets the line width of all increasing values.
  • decreasing
    • marker
      • color (color)
        Sets the marker color of all decreasing values.
      • line
        • color (color)
          Sets the line color of all decreasing values.
        • width (number greater than or equal to 0)
          default: 0
          Sets the line width of all decreasing values.
  • totals
    • marker
      • color (color)
        Sets the marker color of all intermediate sums and total values.
      • line
        • color (color)
          Sets the line color of all intermediate sums and total values.
        • width (number greater than or equal to 0)
          default: 0
          Sets the line width of all intermediate sums and total values.
  • connector
    • line
      • color (color)
        default: "#444"
        Sets the line color.
      • width (number greater than or equal to 0)
        default: 2
        Sets the line width (in px).
      • dash (string)
        default: "solid"
        Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • mode ( enumerated : "spanning" | "between" )
      default: "between"
      Sets the shape of connector lines.
    • visible (boolean)
      default: TRUE
      Determines if connector lines are drawn.
  • offsetgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
  • alignmentgroup (string)
    default: ""
    Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • measuresrc
  • xsrc
  • ysrc
  • hovertextsrc
  • hovertemplatesrc
  • hoverinfosrc
  • textsrc
  • textpositionsrc
  • offsetsrc
  • widthsrc

pie
A pie trace is initialized with plot_ly or add_trace:
plot_ly(df, type="pie"[, ...])
add_trace(p, type="pie"[, ...])
A pie trace accepts any of the keys listed below.



  • type ("pie")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • labels (dataframe column, list, vector)
    Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.
  • label0 (number)
    default: 0
    Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.
  • dlabel (number)
    default: 1
    Sets the label step. See `label0` for more info.
  • values (dataframe column, list, vector)
    Sets the values of the sectors. If omitted, we count occurrences of each label.
  • marker
    • colors (dataframe column, list, vector)
      Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
    • line
      • color (color or array of colors)
        default: "#444"
        Sets the color of the line enclosing each sector.
      • width (number or array of numbers greater than or equal to 0)
        default: 0
        Sets the width (in px) of the line enclosing each sector.
      • colorsrc
      • widthsrc
    • colorssrc
  • text (dataframe column, list, vector)
    Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag.
  • scalegroup (string)
    default: ""
    If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
  • textinfo (flaglist string)
    Any combination of "label", "text", "value", "percent" joined with a "+" OR "none".
    examples: "label", "text", "label+text", "label+text+value", "none"
    Determines which trace information appear on the graph.
  • hoverinfo (flaglist string)
    Any combination of "label", "text", "value", "percent", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "label", "text", "label+text", "label+text+value", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variables `label`, `color`, `value`, `percent` and `text`. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • textposition ( enumerated or array of enumerateds : "inside" | "outside" | "auto" | "none" )
    default: "auto"
    Specifies the location of the `textinfo`.
  • textfont
    Sets the font used for `textinfo`.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • insidetextfont
    Sets the font used for `textinfo` lying inside the sector.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • outsidetextfont
    Sets the font used for `textinfo` lying outside the sector.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • title
    • text (string)
      default: ""
      Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
    • font
      Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • position ( enumerated : "top left" | "top center" | "top right" | "middle center" | "bottom left" | "bottom center" | "bottom right" )
      Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute.
  • domain
    • x (list)
      default: [0, 1]
      Sets the horizontal domain of this pie trace (in plot fraction).
    • y (list)
      default: [0, 1]
      Sets the vertical domain of this pie trace (in plot fraction).
    • row (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this row in the grid for this pie trace .
    • column (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this column in the grid for this pie trace .
  • hole (number between or equal to 0 and 1)
    default: 0
    Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.
  • sort (boolean)
    default: TRUE
    Determines whether or not the sectors are reordered from largest to smallest.
  • direction ( enumerated : "clockwise" | "counterclockwise" )
    default: "counterclockwise"
    Specifies the direction at which succeeding sectors follow one another.
  • rotation (number between or equal to -360 and 360)
    default: 0
    Instead of the first slice starting at 12 o'clock, rotate to some other angle.
  • pull (number or array of numbers between or equal to 0 and 1)
    default: 0
    Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.
  • idssrc
  • customdatasrc
  • metasrc
  • labelssrc
  • valuessrc
  • textsrc
  • hovertextsrc
  • hoverinfosrc
  • hovertemplatesrc
  • textpositionsrc
  • pullsrc

sunburst
A sunburst trace is initialized with plot_ly or add_trace:
plot_ly(df, type="sunburst"[, ...])
add_trace(p, type="sunburst"[, ...])
A sunburst trace accepts any of the keys listed below.



  • type ("sunburst")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • labels (dataframe column, list, vector)
    Sets the labels of each of the sunburst sectors.
  • parents (dataframe column, list, vector)
    Sets the parent sectors for each of the sunburst sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be "ids" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique.
  • values (dataframe column, list, vector)
    Sets the values associated with each of the sunburst sectors. Use with `branchvalues` to determine how the values are summed.
  • branchvalues ( enumerated : "remainder" | "total" )
    default: "remainder"
    Determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.
  • level (number or categorical coordinate string)
    Sets the level from which this sunburst trace hierarchy is rendered. Set `level` to `''` to start the sunburst from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`.
  • maxdepth (integer)
    default: -1
    Sets the number of rendered sunburst rings from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy.
  • marker
    • colors (dataframe column, list, vector)
      Sets the color of each sector of this sunburst chart. If not specified, the default trace color set is used to pick the sector colors.
    • line
      • color (color or array of colors)
        Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.
      • width (number or array of numbers greater than or equal to 0)
        default: 1
        Sets the width (in px) of the line enclosing each sector.
      • colorsrc
      • widthsrc
    • colorssrc
  • leaf
    • opacity (number between or equal to 0 and 1)
      default: 0.7
      Sets the opacity of the leaves.
  • text (dataframe column, list, vector)
    Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • textinfo (flaglist string)
    Any combination of "label", "text", "value" joined with a "+" OR "none".
    examples: "label", "text", "label+text", "label+text+value", "none"
    Determines which trace information appear on the graph.
  • textfont
    Sets the font used for `textinfo`.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag.
  • hoverinfo (flaglist string)
    Any combination of "label", "text", "value", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "label", "text", "label+text", "label+text+value", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • insidetextfont
    Sets the font used for `textinfo` lying inside the sector.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • outsidetextfont
    Sets the font used for `textinfo` lying outside the sector.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • domain
    • x (list)
      default: [0, 1]
      Sets the horizontal domain of this sunburst trace (in plot fraction).
    • y (list)
      default: [0, 1]
      Sets the vertical domain of this sunburst trace (in plot fraction).
    • row (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this row in the grid for this sunburst trace .
    • column (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this column in the grid for this sunburst trace .
  • idssrc
  • customdatasrc
  • metasrc
  • labelssrc
  • parentssrc
  • valuessrc
  • textsrc
  • hovertextsrc
  • hoverinfosrc
  • hovertemplatesrc

funnelarea
A funnelarea trace is initialized with plot_ly or add_trace:
plot_ly(df, type="funnelarea"[, ...])
add_trace(p, type="funnelarea"[, ...])
A funnelarea trace accepts any of the keys listed below.



  • type ("funnelarea")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • labels (dataframe column, list, vector)
    Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.
  • label0 (number)
    default: 0
    Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.
  • dlabel (number)
    default: 1
    Sets the label step. See `label0` for more info.
  • values (dataframe column, list, vector)
    Sets the values of the sectors. If omitted, we count occurrences of each label.
  • marker
    • colors (dataframe column, list, vector)
      Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
    • line
      • color (color or array of colors)
        Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.
      • width (number or array of numbers greater than or equal to 0)
        default: 1
        Sets the width (in px) of the line enclosing each sector.
      • colorsrc
      • widthsrc
    • colorssrc
  • text (dataframe column, list, vector)
    Sets text elements associated with each sector. If trace `textinfo` contains a "text" flag, these elements will be seen on the chart. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a "text" flag.
  • scalegroup (string)
    default: ""
    If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
  • textinfo (flaglist string)
    Any combination of "label", "text", "value", "percent" joined with a "+" OR "none".
    examples: "label", "text", "label+text", "label+text+value", "none"
    Determines which trace information appear on the graph.
  • hoverinfo (flaglist string)
    Any combination of "label", "text", "value", "percent", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "label", "text", "label+text", "label+text+value", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variables `label`, `color`, `value`, `percent` and `text`. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • textposition ( enumerated or array of enumerateds : "inside" | "none" )
    default: "inside"
    Specifies the location of the `textinfo`.
  • textfont
    Sets the font used for `textinfo`.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • insidetextfont
    Sets the font used for `textinfo` lying inside the sector.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • title
    • text (string)
      default: ""
      Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
    • font
      Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • position ( enumerated : "top left" | "top center" | "top right" )
      default: "top center"
      Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute.
  • domain
    • x (list)
      default: [0, 1]
      Sets the horizontal domain of this funnelarea trace (in plot fraction).
    • y (list)
      default: [0, 1]
      Sets the vertical domain of this funnelarea trace (in plot fraction).
    • row (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this row in the grid for this funnelarea trace .
    • column (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this column in the grid for this funnelarea trace .
  • aspectratio (number greater than or equal to 0)
    default: 1
    Sets the ratio between height and width
  • baseratio (number between or equal to 0 and 1)
    default: 0.333
    Sets the ratio between bottom length and maximum top length.
  • idssrc
  • customdatasrc
  • metasrc
  • labelssrc
  • valuessrc
  • textsrc
  • hovertextsrc
  • hoverinfosrc
  • hovertemplatesrc
  • textpositionsrc

scatter3d
A scatter3d trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scatter3d"[, ...])
add_trace(p, type="scatter3d"[, ...])
A scatter3d trace accepts any of the keys listed below.



  • type ("scatter3d")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the x coordinates.
  • y (dataframe column, list, vector)
    Sets the y coordinates.
  • z (dataframe column, list, vector)
    Sets the z coordinates.
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • mode (flaglist string)
    Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    default: "lines+markers"
    Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".
  • surfaceaxis ( enumerated : "-1" | "0" | "1" | "2" )
    default: "-1"
    If "-1", the scatter points are not fill with a surface If "0", "1", "2", the scatter points are filled with a Delaunay surface about the x, y, z respectively.
  • surfacecolor (color)
    Sets the surface fill color.
  • projection
    • x
      • show (boolean)
        Sets whether or not projections are shown along the x axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
    • y
      • show (boolean)
        Sets whether or not projections are shown along the y axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
    • z
      • show (boolean)
        Sets whether or not projections are shown along the z axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • line
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash ( enumerated : "solid" | "dot" | "dash" | "longdash" | "dashdot" | "longdashdot" )
      default: "solid"
      Sets the dash style of the lines.
    • color (color or array of colors)
      Sets thelinecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `FALSE` when `line.cmin` and `line.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `line.color`is set to a numerical array. If TRUE, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • colorsrc
  • marker
    • symbol ( enumerated or array of enumerateds : "circle" | "circle-open" | "square" | "square-open" | "diamond" | "diamond-open" | "cross" | "x" )
      default: "circle"
      Sets the marker symbol type.
    • size (number or array of numbers greater than or equal to 0)
      default: 8
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode ( enumerated : "diameter" | "area" )
      default: "diameter"
      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar value for performance reasons. To set a blending opacity value (i.e. which is not transparent), set "marker.color" to an rgba color and use its alpha channel.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • line
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • colorsrc
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • symbolsrc
    • sizesrc
    • colorsrc
  • textposition ( enumerated or array of enumerateds : "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    default: "top center"
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • textfont
    • color (color or array of colors)
    • size (number or array of numbers greater than or equal to 1)
    • family (string)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • colorsrc
    • sizesrc
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "percent" | "constant" | "sqrt" | "data" )
      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_y
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "percent" | "constant" | "sqrt" | "data" )
      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_z
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "percent" | "constant" | "sqrt" | "data" )
      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • zcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `z` date data.
  • scene (subplotid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • xsrc
  • ysrc
  • zsrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc
  • textpositionsrc
  • hoverinfosrc

surface
A surface trace is initialized with plot_ly or add_trace:
plot_ly(df, type="surface"[, ...])
add_trace(p, type="surface"[, ...])
A surface trace accepts any of the keys listed below.



  • type ("surface")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • z (dataframe column, list, vector)
    Sets the z coordinates.
  • x (dataframe column, list, vector)
    Sets the x coordinates.
  • y (dataframe column, list, vector)
    Sets the y coordinates.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with each z value. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • surfacecolor (dataframe column, list, vector)
    Sets the surface color values, used for setting a color scale independent of `z`.
  • cauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in `cmin` and `cmax` Defaults to `FALSE` when `cmin` and `cmax` are set by the user.
  • cmin (number)
    Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmax` must be set as well.
  • cmax (number)
    Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmin` must be set as well.
  • cmid (number)
    Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as z or surfacecolor. Has no effect when `cauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • contours
    • x
      • show (boolean)
        Determines whether or not contour lines about the x dimension are drawn.
      • start (number)
        Sets the starting contour level value. Must be less than `contours.end`
      • end (number)
        Sets the end contour level value. Must be more than `contours.start`
      • size (number greater than or equal to 0)
        Sets the step between each contour level. Must be positive.
      • project
        • x (boolean)
          Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to "TRUE" (the default), the projected lines are shown on hover. If `show` is set to "TRUE", the projected lines are shown in permanence.
        • y (boolean)
          Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to "TRUE" (the default), the projected lines are shown on hover. If `show` is set to "TRUE", the projected lines are shown in permanence.
        • z (boolean)
          Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to "TRUE" (the default), the projected lines are shown on hover. If `show` is set to "TRUE", the projected lines are shown in permanence.
      • color (color)
        default: "#444"
        Sets the color of the contour lines.
      • usecolormap (boolean)
        An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
      • width (number between or equal to 1 and 16)
        default: 2
        Sets the width of the contour lines.
      • highlight (boolean)
        default: TRUE
        Determines whether or not contour lines about the x dimension are highlighted on hover.
      • highlightcolor (color)
        default: "#444"
        Sets the color of the highlighted contour lines.
      • highlightwidth (number between or equal to 1 and 16)
        default: 2
        Sets the width of the highlighted contour lines.
    • y
      • show (boolean)
        Determines whether or not contour lines about the y dimension are drawn.
      • start (number)
        Sets the starting contour level value. Must be less than `contours.end`
      • end (number)
        Sets the end contour level value. Must be more than `contours.start`
      • size (number greater than or equal to 0)
        Sets the step between each contour level. Must be positive.
      • project
        • x (boolean)
          Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to "TRUE" (the default), the projected lines are shown on hover. If `show` is set to "TRUE", the projected lines are shown in permanence.
        • y (boolean)
          Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to "TRUE" (the default), the projected lines are shown on hover. If `show` is set to "TRUE", the projected lines are shown in permanence.
        • z (boolean)
          Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to "TRUE" (the default), the projected lines are shown on hover. If `show` is set to "TRUE", the projected lines are shown in permanence.
      • color (color)
        default: "#444"
        Sets the color of the contour lines.
      • usecolormap (boolean)
        An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
      • width (number between or equal to 1 and 16)
        default: 2
        Sets the width of the contour lines.
      • highlight (boolean)
        default: TRUE
        Determines whether or not contour lines about the y dimension are highlighted on hover.
      • highlightcolor (color)
        default: "#444"
        Sets the color of the highlighted contour lines.
      • highlightwidth (number between or equal to 1 and 16)
        default: 2
        Sets the width of the highlighted contour lines.
    • z
      • show (boolean)
        Determines whether or not contour lines about the z dimension are drawn.
      • start (number)
        Sets the starting contour level value. Must be less than `contours.end`
      • end (number)
        Sets the end contour level value. Must be more than `contours.start`
      • size (number greater than or equal to 0)
        Sets the step between each contour level. Must be positive.
      • project
        • x (boolean)
          Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to "TRUE" (the default), the projected lines are shown on hover. If `show` is set to "TRUE", the projected lines are shown in permanence.
        • y (boolean)
          Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to "TRUE" (the default), the projected lines are shown on hover. If `show` is set to "TRUE", the projected lines are shown in permanence.
        • z (boolean)
          Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to "TRUE" (the default), the projected lines are shown on hover. If `show` is set to "TRUE", the projected lines are shown in permanence.
      • color (color)
        default: "#444"
        Sets the color of the contour lines.
      • usecolormap (boolean)
        An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale".
      • width (number between or equal to 1 and 16)
        default: 2
        Sets the width of the contour lines.
      • highlight (boolean)
        default: TRUE
        Determines whether or not contour lines about the z dimension are highlighted on hover.
      • highlightcolor (color)
        default: "#444"
        Sets the color of the highlighted contour lines.
      • highlightwidth (number between or equal to 1 and 16)
        default: 2
        Sets the width of the highlighted contour lines.
  • hidesurface (boolean)
    Determines whether or not a surface is drawn. For example, set `hidesurface` to "FALSE" `contours.x.show` to "TRUE" and `contours.y.show` to "TRUE" to draw a wire frame plot.
  • lightposition
    • x (number between or equal to -100000 and 100000)
      default: 10
      Numeric vector, representing the X coordinate for each vertex.
    • y (number between or equal to -100000 and 100000)
      default: 10000
      Numeric vector, representing the Y coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • lighting
    • ambient (number between or equal to 0 and 1)
      default: 0.8
      Ambient light increases overall color visibility but can wash out the image.
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
      Represents the extent that incident rays are reflected in a range of angles.
    • specular (number between or equal to 0 and 2)
      default: 0.05
      Represents the level that incident rays are reflected in a single direction, causing shine.
    • roughness (number between or equal to 0 and 1)
      default: 0.5
      Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
      Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • zcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `z` date data.
  • scene (subplotid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • zsrc
  • xsrc
  • ysrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc
  • surfacecolorsrc
  • hoverinfosrc

isosurface
A isosurface trace is initialized with plot_ly or add_trace:
plot_ly(df, type="isosurface"[, ...])
add_trace(p, type="isosurface"[, ...])
A isosurface trace accepts any of the keys listed below.



  • type ("isosurface")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the X coordinates of the vertices on X axis.
  • y (dataframe column, list, vector)
    Sets the Y coordinates of the vertices on Y axis.
  • z (dataframe column, list, vector)
    Sets the Z coordinates of the vertices on Z axis.
  • value (dataframe column, list, vector)
    Sets the 4th dimension (value) of the vertices.
  • isomin (number)
    Sets the minimum boundary for iso-surface plot.
  • isomax (number)
    Sets the maximum boundary for iso-surface plot.
  • surface
    • show (boolean)
      default: TRUE
      Hides/displays surfaces between minimum and maximum iso-values.
    • count (integer greater than or equal to 1)
      default: 2
      Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.
    • fill (number between or equal to 0 and 1)
      default: 1
      Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • pattern (flaglist string)
      Any combination of "A", "B", "C", "D", "E" joined with a "+" OR "all" or "odd" or "even".
      examples: "A", "B", "A+B", "A+B+C", "all"
      default: "all"
      Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is `all` meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital `A`, `B`, `C`, `D` and `E` may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.
  • spaceframe
    • show (boolean)
      Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.
    • fill (number between or equal to 0 and 1)
      default: 0.15
      Sets the fill ratio of the `spaceframe` elements. The default fill value is 0.15 meaning that only 15% of the area of every faces of tetras would be shaded. Applying a greater `fill` ratio would allow the creation of stronger elements or could be sued to have entirely closed areas (in case of using 1).
  • slices
    • x
      • show (boolean)
        Determines whether or not slice planes about the x dimension are drawn.
      • locations (dataframe column, list, vector)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis x except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • locationssrc
    • y
      • show (boolean)
        Determines whether or not slice planes about the y dimension are drawn.
      • locations (dataframe column, list, vector)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis y except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • locationssrc
    • z
      • show (boolean)
        Determines whether or not slice planes about the z dimension are drawn.
      • locations (dataframe column, list, vector)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis z except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • locationssrc
  • caps
    • x
      • show (boolean)
        default: TRUE
        Sets the fill ratio of the `slices`. The default fill value of the x `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • y
      • show (boolean)
        default: TRUE
        Sets the fill ratio of the `slices`. The default fill value of the y `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • z
      • show (boolean)
        default: TRUE
        Sets the fill ratio of the `slices`. The default fill value of the z `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • cauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `FALSE` when `cmin` and `cmax` are set by the user.
  • cmin (number)
    Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.
  • cmax (number)
    Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well.
  • cmid (number)
    Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    default: TRUE
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
  • lightposition
    • x (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the X coordinate for each vertex.
    • y (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the Y coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • lighting
    • vertexnormalsepsilon (number between or equal to 0 and 1)
      default: 1e-12
      Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
    • facenormalsepsilon (number between or equal to 0 and 1)
      default: 0
      Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
    • ambient (number between or equal to 0 and 1)
      default: 0.8
      Ambient light increases overall color visibility but can wash out the image.
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
      Represents the extent that incident rays are reflected in a range of angles.
    • specular (number between or equal to 0 and 2)
      default: 0.05
      Represents the level that incident rays are reflected in a single direction, causing shine.
    • roughness (number between or equal to 0 and 1)
      default: 0.5
      Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
      Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
  • flatshading (boolean)
    default: TRUE
    Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
  • contour
    • show (boolean)
      Sets whether or not dynamic contours are shown on hover
    • color (color)
      default: "#444"
      Sets the color of the contour lines.
    • width (number between or equal to 1 and 16)
      default: 2
      Sets the width of the contour lines.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • scene (subplotid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • xsrc
  • ysrc
  • zsrc
  • valuesrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc
  • hoverinfosrc

volume
A volume trace is initialized with plot_ly or add_trace:
plot_ly(df, type="volume"[, ...])
add_trace(p, type="volume"[, ...])
A volume trace accepts any of the keys listed below.



  • type ("volume")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the X coordinates of the vertices on X axis.
  • y (dataframe column, list, vector)
    Sets the Y coordinates of the vertices on Y axis.
  • z (dataframe column, list, vector)
    Sets the Z coordinates of the vertices on Z axis.
  • value (dataframe column, list, vector)
    Sets the 4th dimension (value) of the vertices.
  • isomin (number)
    Sets the minimum boundary for iso-surface plot.
  • isomax (number)
    Sets the maximum boundary for iso-surface plot.
  • surface
    • show (boolean)
      default: TRUE
      Hides/displays surfaces between minimum and maximum iso-values.
    • count (integer greater than or equal to 1)
      default: 2
      Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.
    • fill (number between or equal to 0 and 1)
      default: 1
      Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • pattern (flaglist string)
      Any combination of "A", "B", "C", "D", "E" joined with a "+" OR "all" or "odd" or "even".
      examples: "A", "B", "A+B", "A+B+C", "all"
      default: "all"
      Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is `all` meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital `A`, `B`, `C`, `D` and `E` may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.
  • spaceframe
    • show (boolean)
      Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.
    • fill (number between or equal to 0 and 1)
      default: 1
      Sets the fill ratio of the `spaceframe` elements. The default fill value is 1 meaning that they are entirely shaded. Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
  • slices
    • x
      • show (boolean)
        Determines whether or not slice planes about the x dimension are drawn.
      • locations (dataframe column, list, vector)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis x except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • locationssrc
    • y
      • show (boolean)
        Determines whether or not slice planes about the y dimension are drawn.
      • locations (dataframe column, list, vector)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis y except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • locationssrc
    • z
      • show (boolean)
        Determines whether or not slice planes about the z dimension are drawn.
      • locations (dataframe column, list, vector)
        default:
        Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis z except start and end.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • locationssrc
  • caps
    • x
      • show (boolean)
        default: TRUE
        Sets the fill ratio of the `slices`. The default fill value of the x `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • y
      • show (boolean)
        default: TRUE
        Sets the fill ratio of the `slices`. The default fill value of the y `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
    • z
      • show (boolean)
        default: TRUE
        Sets the fill ratio of the `slices`. The default fill value of the z `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
      • fill (number between or equal to 0 and 1)
        default: 1
        Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • cauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `FALSE` when `cmin` and `cmax` are set by the user.
  • cmin (number)
    Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.
  • cmax (number)
    Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well.
  • cmid (number)
    Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    default: TRUE
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
  • opacityscale (number or categorical coordinate string)
    Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.
  • lightposition
    • x (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the X coordinate for each vertex.
    • y (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the Y coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • lighting
    • vertexnormalsepsilon (number between or equal to 0 and 1)
      default: 1e-12
      Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
    • facenormalsepsilon (number between or equal to 0 and 1)
      default: 0
      Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
    • ambient (number between or equal to 0 and 1)
      default: 0.8
      Ambient light increases overall color visibility but can wash out the image.
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
      Represents the extent that incident rays are reflected in a range of angles.
    • specular (number between or equal to 0 and 2)
      default: 0.05
      Represents the level that incident rays are reflected in a single direction, causing shine.
    • roughness (number between or equal to 0 and 1)
      default: 0.5
      Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
      Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
  • flatshading (boolean)
    default: TRUE
    Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
  • contour
    • show (boolean)
      Sets whether or not dynamic contours are shown on hover
    • color (color)
      default: "#444"
      Sets the color of the contour lines.
    • width (number between or equal to 1 and 16)
      default: 2
      Sets the width of the contour lines.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • scene (subplotid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • xsrc
  • ysrc
  • zsrc
  • valuesrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc
  • hoverinfosrc

mesh3d
A mesh3d trace is initialized with plot_ly or add_trace:
plot_ly(df, type="mesh3d"[, ...])
add_trace(p, type="mesh3d"[, ...])
A mesh3d trace accepts any of the keys listed below.



  • type ("mesh3d")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the X coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.
  • y (dataframe column, list, vector)
    Sets the Y coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.
  • z (dataframe column, list, vector)
    Sets the Z coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.
  • i (dataframe column, list, vector)
    A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "first" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `i[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `i` represents a point in space, which is the first vertex of a triangle.
  • j (dataframe column, list, vector)
    A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "second" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `j[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `j` represents a point in space, which is the second vertex of a triangle.
  • k (dataframe column, list, vector)
    A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the "third" vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `k[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `k` represents a point in space, which is the third vertex of a triangle.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with the vertices. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • delaunayaxis ( enumerated : "x" | "y" | "z" )
    default: "z"
    Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if `i`, `j`, `k` are not provided and `alphahull` is set to indicate Delaunay triangulation.
  • alphahull (number)
    default: -1
    Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays are not supplied. For general use of `mesh3d` it is preferred that `i`, `j`, `k` are supplied. If "-1", Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to `delaunayaxis`. In case the `delaunayaxis` intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of `delaunayaxis`. If ">0", the alpha-shape algorithm is used. In this case, the positive `alphahull` value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If "0", the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the `x`, `y` and `z` point set into a convex hull.
  • intensity (dataframe column, list, vector)
    Sets the vertex intensity values, used for plotting fields on meshes
  • color (color)
    Sets the color of the whole mesh
  • vertexcolor (dataframe column, list, vector)
    Sets the color of each vertex Overrides "color". While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.
  • facecolor (dataframe column, list, vector)
    Sets the color of each face Overrides "color" and "vertexcolor".
  • cauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here `intensity`) or the bounds set in `cmin` and `cmax` Defaults to `FALSE` when `cmin` and `cmax` are set by the user.
  • cmin (number)
    Sets the lower bound of the color domain. Value should have the same units as `intensity` and if set, `cmax` must be set as well.
  • cmax (number)
    Sets the upper bound of the color domain. Value should have the same units as `intensity` and if set, `cmin` must be set as well.
  • cmid (number)
    Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `intensity`. Has no effect when `cauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    default: TRUE
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
  • flatshading (boolean)
    Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
  • contour
    • show (boolean)
      Sets whether or not dynamic contours are shown on hover
    • color (color)
      default: "#444"
      Sets the color of the contour lines.
    • width (number between or equal to 1 and 16)
      default: 2
      Sets the width of the contour lines.
  • lightposition
    • x (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the X coordinate for each vertex.
    • y (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the Y coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • lighting
    • vertexnormalsepsilon (number between or equal to 0 and 1)
      default: 1e-12
      Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
    • facenormalsepsilon (number between or equal to 0 and 1)
      default: 1e-06
      Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
    • ambient (number between or equal to 0 and 1)
      default: 0.8
      Ambient light increases overall color visibility but can wash out the image.
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
      Represents the extent that incident rays are reflected in a range of angles.
    • specular (number between or equal to 0 and 2)
      default: 0.05
      Represents the level that incident rays are reflected in a single direction, causing shine.
    • roughness (number between or equal to 0 and 1)
      default: 0.5
      Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
      Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • zcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `z` date data.
  • scene (subplotid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • xsrc
  • ysrc
  • zsrc
  • isrc
  • jsrc
  • ksrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc
  • intensitysrc
  • vertexcolorsrc
  • facecolorsrc
  • hoverinfosrc

cone
A cone trace is initialized with plot_ly or add_trace:
plot_ly(df, type="cone"[, ...])
add_trace(p, type="cone"[, ...])
A cone trace accepts any of the keys listed below.



  • type ("cone")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the x coordinates of the vector field and of the displayed cones.
  • y (dataframe column, list, vector)
    Sets the y coordinates of the vector field and of the displayed cones.
  • z (dataframe column, list, vector)
    Sets the z coordinates of the vector field and of the displayed cones.
  • u (dataframe column, list, vector)
    Sets the x components of the vector field.
  • v (dataframe column, list, vector)
    Sets the y components of the vector field.
  • w (dataframe column, list, vector)
    Sets the z components of the vector field.
  • sizemode ( enumerated : "scaled" | "absolute" )
    default: "scaled"
    Determines whether `sizeref` is set as a "scaled" (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as "absolute" value (in the same units as the vector field).
  • sizeref (number greater than or equal to 0)
    Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`. This factor (computed internally) corresponds to the minimum "time" to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With `sizemode` set to "scaled", `sizeref` is unitless, its default value is "0.5" With `sizemode` set to "absolute", `sizeref` has the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm.
  • anchor ( enumerated : "tip" | "tail" | "cm" | "center" )
    default: "cm"
    Sets the cones' anchor with respect to their x/y/z positions. Note that "cm" denote the cone's center of mass which corresponds to 1/4 from the tail to tip.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with the cones. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variable `norm` Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • cauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `FALSE` when `cmin` and `cmax` are set by the user.
  • cmin (number)
    Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well.
  • cmax (number)
    Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well.
  • cmid (number)
    Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    default: TRUE
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
  • lightposition
    • x (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the X coordinate for each vertex.
    • y (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the Y coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • lighting
    • vertexnormalsepsilon (number between or equal to 0 and 1)
      default: 1e-12
      Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
    • facenormalsepsilon (number between or equal to 0 and 1)
      default: 1e-06
      Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
    • ambient (number between or equal to 0 and 1)
      default: 0.8
      Ambient light increases overall color visibility but can wash out the image.
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
      Represents the extent that incident rays are reflected in a range of angles.
    • specular (number between or equal to 0 and 2)
      default: 0.05
      Represents the level that incident rays are reflected in a single direction, causing shine.
    • roughness (number between or equal to 0 and 1)
      default: 0.5
      Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
      Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "u", "v", "w", "norm", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "x+y+z+norm+text+name"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • scene (subplotid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • xsrc
  • ysrc
  • zsrc
  • usrc
  • vsrc
  • wsrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc
  • hoverinfosrc

streamtube
A streamtube trace is initialized with plot_ly or add_trace:
plot_ly(df, type="streamtube"[, ...])
add_trace(p, type="streamtube"[, ...])
A streamtube trace accepts any of the keys listed below.



  • type ("streamtube")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the x coordinates of the vector field.
  • y (dataframe column, list, vector)
    Sets the y coordinates of the vector field.
  • z (dataframe column, list, vector)
    Sets the z coordinates of the vector field.
  • u (dataframe column, list, vector)
    Sets the x components of the vector field.
  • v (dataframe column, list, vector)
    Sets the y components of the vector field.
  • w (dataframe column, list, vector)
    Sets the z components of the vector field.
  • starts
    • x (dataframe column, list, vector)
      Sets the x components of the starting position of the streamtubes
    • y (dataframe column, list, vector)
      Sets the y components of the starting position of the streamtubes
    • z (dataframe column, list, vector)
      Sets the z components of the starting position of the streamtubes
    • xsrc
    • ysrc
    • zsrc
  • maxdisplayed (integer greater than or equal to 0)
    default: 1000
    The maximum number of displayed segments in a streamtube.
  • sizeref (number greater than or equal to 0)
    default: 1
    The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.
  • text (string)
    default: ""
    Sets a text element associated with this trace. If trace `hoverinfo` contains a "text" flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array `text` values.
  • hovertext (string)
    default: ""
    Same as `text`.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variables `tubex`, `tubey`, `tubez`, `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • cauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `FALSE` when `cmin` and `cmax` are set by the user.
  • cmin (number)
    Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well.
  • cmax (number)
    Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well.
  • cmid (number)
    Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    default: TRUE
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
  • lightposition
    • x (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the X coordinate for each vertex.
    • y (number between or equal to -100000 and 100000)
      default: 100000
      Numeric vector, representing the Y coordinate for each vertex.
    • z (number between or equal to -100000 and 100000)
      default: 0
      Numeric vector, representing the Z coordinate for each vertex.
  • lighting
    • vertexnormalsepsilon (number between or equal to 0 and 1)
      default: 1e-12
      Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
    • facenormalsepsilon (number between or equal to 0 and 1)
      default: 1e-06
      Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
    • ambient (number between or equal to 0 and 1)
      default: 0.8
      Ambient light increases overall color visibility but can wash out the image.
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
      Represents the extent that incident rays are reflected in a range of angles.
    • specular (number between or equal to 0 and 2)
      default: 0.05
      Represents the level that incident rays are reflected in a single direction, causing shine.
    • roughness (number between or equal to 0 and 1)
      default: 0.5
      Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
      Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "u", "v", "w", "norm", "divergence", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "x+y+z+norm+text+name"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • scene (subplotid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If "scene" (the default value), the (x,y,z) coordinates refer to `layout.scene`. If "scene2", the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • xsrc
  • ysrc
  • zsrc
  • usrc
  • vsrc
  • wsrc
  • hovertemplatesrc
  • hoverinfosrc

scattergeo
A scattergeo trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scattergeo"[, ...])
add_trace(p, type="scattergeo"[, ...])
A scattergeo trace accepts any of the keys listed below.



  • type ("scattergeo")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • lon (dataframe column, list, vector)
    Sets the longitude coordinates (in degrees East).
  • lat (dataframe column, list, vector)
    Sets the latitude coordinates (in degrees North).
  • locations (dataframe column, list, vector)
    Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.
  • locationmode ( enumerated : "ISO-3" | "USA-states" | "country names" )
    default: "ISO-3"
    Determines the set of locations used to match entries in `locations` to regions on the map.
  • mode (flaglist string)
    Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    default: "markers"
    Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • textfont
    Sets the text font.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • textposition ( enumerated or array of enumerateds : "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    default: "middle center"
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: "solid"
      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • marker
    • symbol ( enumerated or array of enumerateds : "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      default: "circle"
      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
    • opacity (number or array of numbers between or equal to 0 and 1)
      Sets the marker opacity.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode ( enumerated : "diameter" | "area" )
      default: "diameter"
      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • line
      • width (number or array of numbers greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • widthsrc
      • colorsrc
    • gradient
      • type ( enumerated or array of enumerateds : "radial" | "horizontal" | "vertical" | "none" )
        default: "none"
        Sets the type of gradient used to fill the markers
      • color (color or array of colors)
        Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.
      • typesrc
      • colorsrc
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • symbolsrc
    • opacitysrc
    • sizesrc
    • colorsrc
  • fill ( enumerated : "none" | "toself" )
    default: "none"
    Sets the area to fill with a solid color. Use with `fillcolor` if not "none". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • hoverinfo (flaglist string)
    Any combination of "lon", "lat", "location", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "lon", "lat", "lon+lat", "lon+lat+location", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • geo (subplotid)
    default: geo
    Sets a reference between this trace's geospatial coordinates and a geographic map. If "geo" (the default value), the geospatial coordinates refer to `layout.geo`. If "geo2", the geospatial coordinates refer to `layout.geo2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • lonsrc
  • latsrc
  • locationssrc
  • textsrc
  • hovertextsrc
  • textpositionsrc
  • hoverinfosrc
  • hovertemplatesrc

choropleth
A choropleth trace is initialized with plot_ly or add_trace:
plot_ly(df, type="choropleth"[, ...])
add_trace(p, type="choropleth"[, ...])
A choropleth trace accepts any of the keys listed below.



  • type ("choropleth")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • locations (dataframe column, list, vector)
    Sets the coordinates via location IDs or names. See `locationmode` for more info.
  • locationmode ( enumerated : "ISO-3" | "USA-states" | "country names" )
    default: "ISO-3"
    Determines the set of locations used to match entries in `locations` to regions on the map.
  • z (dataframe column, list, vector)
    Sets the color values.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with each location.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • marker
    • line
      • color (color or array of colors)
        default: "#444"
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • width (number or array of numbers greater than or equal to 0)
        default: 1
        Sets the width (in px) of the lines bounding the marker points.
      • colorsrc
      • widthsrc
    • opacity (number or array of numbers between or equal to 0 and 1)
      default: 1
      Sets the opacity of the locations.
    • opacitysrc
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
  • hoverinfo (flaglist string)
    Any combination of "location", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "location", "z", "location+z", "location+z+text", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • zauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.
  • zmin (number)
    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
  • zmax (number)
    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
  • zmid (number)
    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    default: TRUE
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • geo (subplotid)
    default: geo
    Sets a reference between this trace's geospatial coordinates and a geographic map. If "geo" (the default value), the geospatial coordinates refer to `layout.geo`. If "geo2", the geospatial coordinates refer to `layout.geo2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • locationssrc
  • zsrc
  • textsrc
  • hovertextsrc
  • hoverinfosrc
  • hovertemplatesrc

scattergl
A scattergl trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scattergl"[, ...])
add_trace(p, type="scattergl"[, ...])
A scattergl trace accepts any of the keys listed below.



  • type ("scattergl")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (dataframe column, list, vector)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • textposition ( enumerated or array of enumerateds : "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    default: "middle center"
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • textfont
    Sets the text font.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • mode (flaglist string)
    Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    Determines the drawing mode for this scatter trace.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • shape ( enumerated : "linear" | "hv" | "vh" | "hvh" | "vhv" )
      default: "linear"
      Determines the line shape. The values correspond to step-wise line shapes.
    • dash ( enumerated : "solid" | "dot" | "dash" | "longdash" | "dashdot" | "longdashdot" )
      default: "solid"
      Sets the style of the lines.
  • marker
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • symbol ( enumerated or array of enumerateds : "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      default: "circle"
      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode ( enumerated : "diameter" | "area" )
      default: "diameter"
      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • opacity (number or array of numbers between or equal to 0 and 1)
      Sets the marker opacity.
    • line
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • width (number or array of numbers greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorsrc
      • widthsrc
    • colorsrc
    • symbolsrc
    • sizesrc
    • opacitysrc
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • fill ( enumerated : "none" | "tozeroy" | "tozerox" | "tonexty" | "tonextx" | "toself" | "tonext" )
    default: "none"
    Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "percent" | "constant" | "sqrt" | "data" )
      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_y
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type ( enumerated : "percent" | "constant" | "sqrt" | "data" )
      Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the sqaure of the underlying data. If "data", the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (dataframe column, list, vector)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • ycalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `y` date data.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • xsrc
  • ysrc
  • textsrc
  • hovertextsrc
  • textpositionsrc
  • hovertemplatesrc

splom
A splom trace is initialized with plot_ly or add_trace:
plot_ly(df, type="splom"[, ...])
add_trace(p, type="splom"[, ...])
A splom trace accepts any of the keys listed below.



  • type ("splom")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • dimensions
    Each named list has one or more of the keys listed below.
    • visible (boolean)
      default: TRUE
      Determines whether or not this dimension is shown on the graph. Note that even visible FALSE dimension contribute to the default grid generate by this splom trace.
    • label (string)
      Sets the label corresponding to this splom dimension.
    • values (dataframe column, list, vector)
      Sets the dimension values to be plotted.
    • axis
      • type ( enumerated : "linear" | "log" | "date" | "category" )
        Sets the axis type for this dimension's generated x and y axes. Note that the axis `type` values set in layout take precedence over this attribute.
      • matches (boolean)
        Determines whether or not the x & y axes generated by this dimension match. Equivalent to setting the `matches` axis attribute in the layout with the correct axis id.
    • name (string)
      When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
    • templateitemname (string)
      Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • valuessrc
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • marker
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • symbol ( enumerated or array of enumerateds : "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      default: "circle"
      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode ( enumerated : "diameter" | "area" )
      default: "diameter"
      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • opacity (number or array of numbers between or equal to 0 and 1)
      Sets the marker opacity.
    • line
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • width (number or array of numbers greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorsrc
      • widthsrc
    • colorsrc
    • symbolsrc
    • sizesrc
    • opacitysrc
  • xaxes (list)
    Sets the list of x axes corresponding to dimensions of this splom trace. By default, a splom will match the first N xaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is FALSE and `showupperhalf` or `showlowerhalf` is FALSE, this splom trace will generate one less x-axis and one less y-axis.
  • yaxes (list)
    Sets the list of y axes corresponding to dimensions of this splom trace. By default, a splom will match the first N yaxes where N is the number of input dimensions. Note that, in case where `diagonal.visible` is FALSE and `showupperhalf` or `showlowerhalf` is FALSE, this splom trace will generate one less x-axis and one less y-axis.
  • diagonal
    • visible (boolean)
      default: TRUE
      Determines whether or not subplots on the diagonal are displayed.
  • showupperhalf (boolean)
    default: TRUE
    Determines whether or not subplots on the upper half from the diagonal are displayed.
  • showlowerhalf (boolean)
    default: TRUE
    Determines whether or not subplots on the lower half from the diagonal are displayed.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc

pointcloud
A pointcloud trace is initialized with plot_ly or add_trace:
plot_ly(df, type="pointcloud"[, ...])
add_trace(p, type="pointcloud"[, ...])
A pointcloud trace accepts any of the keys listed below.



  • type ("pointcloud")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the x coordinates.
  • y (dataframe column, list, vector)
    Sets the y coordinates.
  • xy (dataframe column, list, vector)
    Faster alternative to specifying `x` and `y` separately. If supplied, it must be a typed `Float32Array` array that represents points such that `xy[i " 2] = x[i]` and `xy[i " 2 + 1] = y[i]`
  • indices (dataframe column, list, vector)
    A sequential value, 0..n, supply it to avoid creating this array inside plotting. If specified, it must be a typed `Int32Array` array. Its length must be equal to or greater than the number of points. For the best performance and memory use, create one large `indices` typed array that is guaranteed to be at least as long as the largest number of points during use, and reuse it on each `Plotly.restyle()` call.
  • xbounds (dataframe column, list, vector)
    Specify `xbounds` in the shape of `[xMin, xMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `ybounds` for the performance benefits.
  • ybounds (dataframe column, list, vector)
    Specify `ybounds` in the shape of `[yMin, yMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `xbounds` for the performance benefits.
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • marker
    • color (color)
      Sets the marker fill color. It accepts a specific color.If the color is not fully opaque and there are hundreds of thousandsof points, it may cause slower zooming and panning.
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the marker opacity. The default value is `1` (fully opaque). If the markers are not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning. Opacity fades the color even if `blend` is left on `FALSE` even if there is no translucency effect in that case.
    • blend (boolean)
      Determines if colors are blended together for a translucency effect in case `opacity` is specified as a value less then `1`. Setting `blend` to `TRUE` reduces zoom/pan speed if used with large numbers of points.
    • sizemin (number between or equal to 0.1 and 2)
      default: 0.5
      Sets the minimum size (in px) of the rendered marker points, effective when the `pointcloud` shows a million or more points.
    • sizemax (number greater than or equal to 0.1)
      default: 20
      Sets the maximum size (in px) of the rendered marker points. Effective when the `pointcloud` shows only few points.
    • border
      • color (color)
        Sets the stroke color. It accepts a specific color. If the color is not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning.
      • arearatio (number between or equal to 0 and 1)
        default: 0
        Specifies what fraction of the marker area is covered with the border.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • xsrc
  • ysrc
  • xysrc
  • indicessrc
  • xboundssrc
  • yboundssrc
  • textsrc

heatmapgl
A heatmapgl trace is initialized with plot_ly or add_trace:
plot_ly(df, type="heatmapgl"[, ...])
add_trace(p, type="heatmapgl"[, ...])
A heatmapgl trace accepts any of the keys listed below.



  • type ("heatmapgl")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • z (dataframe column, list, vector)
    Sets the z data.
  • x (dataframe column, list, vector)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (dataframe column, list, vector)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (dataframe column, list, vector)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype ( enumerated : "array" | "scaled" )
    If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided).
  • ytype ( enumerated : "array" | "scaled" )
    If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.
  • zmin (number)
    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
  • zmax (number)
    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
  • zmid (number)
    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • zsrc
  • xsrc
  • ysrc
  • textsrc

parcoords
A parcoords trace is initialized with plot_ly or add_trace:
plot_ly(df, type="parcoords"[, ...])
add_trace(p, type="parcoords"[, ...])
A parcoords trace accepts any of the keys listed below.



  • type ("parcoords")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • domain
    • x (list)
      default: [0, 1]
      Sets the horizontal domain of this parcoords trace (in plot fraction).
    • y (list)
      default: [0, 1]
      Sets the vertical domain of this parcoords trace (in plot fraction).
    • row (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this row in the grid for this parcoords trace .
    • column (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this column in the grid for this parcoords trace .
  • labelangle (angle)
    default: 0
    Sets the angle of the labels with respect to the horizontal. For example, a `tickangle` of -90 draws the labels vertically. Tilted labels with "labelangle" may be positioned better inside margins when `labelposition` is set to "bottom".
  • labelside ( enumerated : "top" | "bottom" )
    default: "top"
    Specifies the location of the `label`. "top" positions labels above, next to the title "bottom" positions labels below the graph Tilted labels with "labelangle" may be positioned better inside margins when `labelposition` is set to "bottom".
  • labelfont
    Sets the font for the `dimension` labels.
    • family (string)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number greater than or equal to 1)
    • color (color)
  • tickfont
    Sets the font for the `dimension` tick values.
    • family (string)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number greater than or equal to 1)
    • color (color)
  • rangefont
    Sets the font for the `dimension` range values.
    • family (string)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number greater than or equal to 1)
    • color (color)
  • dimensions
    Each named list has one or more of the keys listed below.
    • label (string)
      The shown name of the dimension.
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • visible (boolean)
      default: TRUE
      Shows the dimension when set to `TRUE` (the default). Hides the dimension for `FALSE`.
    • range (list)
      The domain range that represents the full, shown axis extent. Defaults to the `values` extent. Must be an array of `[fromValue, toValue]` with finite numbers as elements.
    • constraintrange (list)
      The domain range to which the filter on the dimension is constrained. Must be an array of `[fromValue, toValue]` with `fromValue <= toValue`, or if `multiselect` is not disabled, you may give an array of arrays, where each inner array is `[fromValue, toValue]`.
    • multiselect (boolean)
      default: TRUE
      Do we allow multiple selection ranges or just a single range?
    • values (dataframe column, list, vector)
      Dimension values. `values[n]` represents the value of the `n`th point in the dataset, therefore the `values` vector for all dimensions must be the same (longer vectors will be truncated). Each value must be a finite number.
    • name (string)
      When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
    • templateitemname (string)
      Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickvalssrc
    • ticktextsrc
    • valuessrc
  • line
    • color (color or array of colors)
      Sets thelinecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `FALSE` when `line.cmin` and `line.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `FALSE`.
    • colorscale (colorscale)
      default: 0#4401540.06274509803921569#48186a0.12549019607843137#472d7b0.18823529411764706#4240860.25098039215686274#3b528b0.3137254901960784#33638d0.3764705882352941#2c728e0.4392156862745098#26828e0.5019607843137255#21918c0.5647058823529412#1fa0880.6274509803921569#28ae800.6901960784313725#3fbc730.7529411764705882#5ec9620.8156862745098039#84d44b0.8784313725490196#addc300.9411764705882353#d8e2191#fde725
      Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `line.color`is set to a numerical array. If TRUE, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • colorsrc
  • idssrc
  • customdatasrc
  • metasrc

parcats
A parcats trace is initialized with plot_ly or add_trace:
plot_ly(df, type="parcats"[, ...])
add_trace(p, type="parcats"[, ...])
A parcats trace accepts any of the keys listed below.



  • type ("parcats")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • domain
    • x (list)
      default: [0, 1]
      Sets the horizontal domain of this parcats trace (in plot fraction).
    • y (list)
      default: [0, 1]
      Sets the vertical domain of this parcats trace (in plot fraction).
    • row (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this row in the grid for this parcats trace .
    • column (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this column in the grid for this parcats trace .
  • hoverinfo (flaglist string)
    Any combination of "count", "probability" joined with a "+" OR "all" or "none" or "skip".
    examples: "count", "probability", "count+probability", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoveron ( enumerated : "category" | "color" | "dimension" )
    default: "category"
    Sets the hover interaction mode for the parcats diagram. If `category`, hover interaction take place per category. If `color`, hover interactions take place per color per category. If `dimension`, hover interactions take place across all categories per dimension.
  • hovertemplate (string)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variables `count`, `probability`, `category`, `categorycount`, `colorcount` and `bandcolorcount`. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • arrangement ( enumerated : "perpendicular" | "freeform" | "fixed" )
    default: "perpendicular"
    Sets the drag interaction mode for categories and dimensions. If `perpendicular`, the categories can only move along a line perpendicular to the paths. If `freeform`, the categories can freely move on the plane. If `fixed`, the categories and dimensions are stationary.
  • bundlecolors (boolean)
    default: TRUE
    Sort paths so that like colors are bundled together within each category.
  • sortpaths ( enumerated : "forward" | "backward" )
    default: "forward"
    Sets the path sorting algorithm. If `forward`, sort paths based on dimension categories from left to right. If `backward`, sort paths based on dimensions categories from right to left.
  • labelfont
    Sets the font for the `dimension` labels.
    • family (string)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number greater than or equal to 1)
    • color (color)
  • tickfont
    Sets the font for the `category` labels.
    • family (string)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number greater than or equal to 1)
    • color (color)
  • dimensions
    Each named list has one or more of the keys listed below.
    • label (string)
      The shown name of the dimension.
    • categoryorder ( enumerated : "trace" | "category ascending" | "category descending" | "array" )
      default: "trace"
      Specifies the ordering logic for the categories in the dimension. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`.
    • categoryarray (dataframe column, list, vector)
      Sets the order in which categories in this dimension appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
    • ticktext (dataframe column, list, vector)
      Sets alternative tick labels for the categories in this dimension. Only has an effect if `categoryorder` is set to "array". Should be an array the same length as `categoryarray` Used with `categoryorder`.
    • values (dataframe column, list, vector)
      default:
      Dimension values. `values[n]` represents the category value of the `n`th point in the dataset, therefore the `values` vector for all dimensions must be the same (longer vectors will be truncated).
    • displayindex (integer)
      The display index of dimension, from left to right, zero indexed, defaults to dimension index.
    • visible (boolean)
      default: TRUE
      Shows the dimension when set to `TRUE` (the default). Hides the dimension for `FALSE`.
    • categoryarraysrc
    • ticktextsrc
    • valuessrc
  • line
    • color (color or array of colors)
      Sets thelinecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `FALSE` when `line.cmin` and `line.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `line.color`is set to a numerical array. If TRUE, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • shape ( enumerated : "linear" | "hspline" )
      default: "linear"
      Sets the shape of the paths. If `linear`, paths are composed of straight lines. If `hspline`, paths are composed of horizontal curved splines
    • hovertemplate (string)
      default: ""
      Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variables `count` and `probability`. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
    • colorsrc
  • counts (number or array of numbers greater than or equal to 0)
    default: 1
    The number of observations represented by each state. Defaults to 1 so that each state represents one observation
  • metasrc
  • countssrc

scattermapbox
A scattermapbox trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scattermapbox"[, ...])
add_trace(p, type="scattermapbox"[, ...])
A scattermapbox trace accepts any of the keys listed below.



  • type ("scattermapbox")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • lon (dataframe column, list, vector)
    Sets the longitude coordinates (in degrees East).
  • lat (dataframe column, list, vector)
    Sets the latitude coordinates (in degrees North).
  • mode (flaglist string)
    Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    default: "markers"
    Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover.
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • marker
    • symbol (string or array of strings)
      default: "circle"
      Sets the marker symbol. Full list: https://www.mapbox.com/maki-icons/ Note that the array `marker.color` and `marker.size` are only available for "circle" symbols.
    • opacity (number or array of numbers between or equal to 0 and 1)
      Sets the marker opacity.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode ( enumerated : "diameter" | "area" )
      default: "diameter"
      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • symbolsrc
    • opacitysrc
    • sizesrc
    • colorsrc
  • fill ( enumerated : "none" | "toself" )
    default: "none"
    Sets the area to fill with a solid color. Use with `fillcolor` if not "none". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • textfont
    Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.layer.layout.text-size). Has an effect only when `type` is set to "symbol".
    • family (string)
      default: "Open Sans Regular, Arial Unicode MS Regular"
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number greater than or equal to 1)
    • color (color)
  • textposition ( enumerated : "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    default: "middle center"
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • below (string)
    Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
  • hoverinfo (flaglist string)
    Any combination of "lon", "lat", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "lon", "lat", "lon+lat", "lon+lat+text", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • subplot (subplotid)
    default: mapbox
    Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • lonsrc
  • latsrc
  • textsrc
  • hovertextsrc
  • hoverinfosrc
  • hovertemplatesrc

choroplethmapbox
A choroplethmapbox trace is initialized with plot_ly or add_trace:
plot_ly(df, type="choroplethmapbox"[, ...])
add_trace(p, type="choroplethmapbox"[, ...])
A choroplethmapbox trace accepts any of the keys listed below.



  • type ("choroplethmapbox")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • locations (dataframe column, list, vector)
    Sets which features found in "geojson" to plot using their feature `id` field.
  • z (dataframe column, list, vector)
    Sets the color values.
  • geojson (number or categorical coordinate string)
    Sets the GeoJSON data associated with this trace. Can be set as a valid GeoJSON object or as URL string Note that we only accept GeoJSON of type "FeatureCollection" and "Feature" with geometries of type "Polygon" and "MultiPolygon".
  • below (string)
    Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to '', the layer will be inserted above every existing layer.
  • text (string or array of strings)
    default: ""
    Sets the text elements associated with each location.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • marker
    • line
      • color (color or array of colors)
        default: "#444"
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • width (number or array of numbers greater than or equal to 0)
        default: 1
        Sets the width (in px) of the lines bounding the marker points.
      • colorsrc
      • widthsrc
    • opacity (number or array of numbers between or equal to 0 and 1)
      default: 1
      Sets the opacity of the locations.
    • opacitysrc
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
  • hoverinfo (flaglist string)
    Any combination of "location", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "location", "z", "location+z", "location+z+text", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variable `properties` Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • zauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.
  • zmin (number)
    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
  • zmax (number)
    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
  • zmid (number)
    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    default: TRUE
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • subplot (subplotid)
    default: mapbox
    Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • locationssrc
  • zsrc
  • textsrc
  • hovertextsrc
  • hoverinfosrc
  • hovertemplatesrc

densitymapbox
A densitymapbox trace is initialized with plot_ly or add_trace:
plot_ly(df, type="densitymapbox"[, ...])
add_trace(p, type="densitymapbox"[, ...])
A densitymapbox trace accepts any of the keys listed below.



  • type ("densitymapbox")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • lon (dataframe column, list, vector)
    Sets the longitude coordinates (in degrees East).
  • lat (dataframe column, list, vector)
    Sets the latitude coordinates (in degrees North).
  • z (dataframe column, list, vector)
    Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot
  • radius (number or array of numbers greater than or equal to 1)
    default: 30
    Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.
  • below (string)
    Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to '', the layer will be inserted above every existing layer.
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • hoverinfo (flaglist string)
    Any combination of "lon", "lat", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "lon", "lat", "lon+lat", "lon+lat+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • zauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.
  • zmin (number)
    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
  • zmax (number)
    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
  • zmid (number)
    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    default: TRUE
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • subplot (subplotid)
    default: mapbox
    Sets a reference between this trace's data coordinates and a mapbox subplot. If "mapbox" (the default value), the data refer to `layout.mapbox`. If "mapbox2", the data refer to `layout.mapbox2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • lonsrc
  • latsrc
  • zsrc
  • radiussrc
  • textsrc
  • hovertextsrc
  • hoverinfosrc
  • hovertemplatesrc

sankey
A sankey trace is initialized with plot_ly or add_trace:
plot_ly(df, type="sankey"[, ...])
add_trace(p, type="sankey"[, ...])
A sankey trace accepts any of the keys listed below.



  • type ("sankey")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • hoverinfo (flaglist string)
    Any combination of joined with a "+" OR "all" or "none" or "skip".
    examples: "", "", "+", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. Note that this attribute is superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • domain
    • x (list)
      default: [0, 1]
      Sets the horizontal domain of this sankey trace (in plot fraction).
    • y (list)
      default: [0, 1]
      Sets the vertical domain of this sankey trace (in plot fraction).
    • row (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this row in the grid for this sankey trace .
    • column (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this column in the grid for this sankey trace .
  • orientation ( enumerated : "v" | "h" )
    default: "h"
    Sets the orientation of the Sankey diagram.
  • valueformat (string)
    default: ".3s"
    Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
  • valuesuffix (string)
    default: ""
    Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.
  • arrangement ( enumerated : "snap" | "perpendicular" | "freeform" | "fixed" )
    default: "snap"
    If value is `snap` (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via `nodepad`. If value is `perpendicular`, the nodes can only move along a line perpendicular to the flow. If value is `freeform`, the nodes can freely move on the plane. If value is `fixed`, the nodes are stationary.
  • textfont
    Sets the font for node labels
    • family (string)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number greater than or equal to 1)
    • color (color)
  • node
    The nodes of the Sankey plot.
    • label (dataframe column, list, vector)
      default:
      The shown name of the node.
    • groups (list)
      default: [, ]
      Groups of nodes. Each group is defined by an array with the indices of the nodes it contains. Multiple groups can be specified.
    • x (dataframe column, list, vector)
      default:
      The normalized horizontal position of the node.
    • y (dataframe column, list, vector)
      default:
      The normalized vertical position of the node.
    • color (color or array of colors)
      Sets the `node` color. It can be a single value, or an array for specifying color for each `node`. If `node.color` is omitted, then the default `Plotly` color palette will be cycled through to have a variety of colors. These defaults are not fully opaque, to allow some visibility of what is beneath the node.
    • line
      • color (color or array of colors)
        default: "#444"
        Sets the color of the `line` around each `node`.
      • width (number or array of numbers greater than or equal to 0)
        default: 0.5
        Sets the width (in px) of the `line` around each `node`.
      • colorsrc
      • widthsrc
    • pad (number greater than or equal to 0)
      default: 20
      Sets the padding (in px) between the `nodes`.
    • thickness (number greater than or equal to 1)
      default: 20
      Sets the thickness (in px) of the `nodes`.
    • hoverinfo ( enumerated : "all" | "none" | "skip" )
      default: "all"
      Determines which trace information appear when hovering nodes. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
    • hoverlabel
      • bgcolor (color or array of colors)
        Sets the background color of the hover labels for this trace
      • bordercolor (color or array of colors)
        Sets the border color of the hover labels for this trace.
      • font
        Sets the font used in hover labels.
        • family (string or array of strings)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number or array of numbers greater than or equal to 1)
        • color (color or array of colors)
        • familysrc
        • sizesrc
        • colorsrc
      • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
        default: "auto"
        Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
      • namelength (integer or array of integers greater than or equal to -1)
        default: 15
        Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
      • bgcolorsrc
      • bordercolorsrc
      • alignsrc
      • namelengthsrc
    • hovertemplate (string or array of strings)
      default: ""
      Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variables `value` and `label`. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
    • labelsrc
    • xsrc
    • ysrc
    • colorsrc
    • hovertemplatesrc
  • link
    The links of the Sankey plot.
    • label (dataframe column, list, vector)
      default:
      The shown name of the link.
    • color (color or array of colors)
      Sets the `link` color. It can be a single value, or an array for specifying color for each `link`. If `link.color` is omitted, then by default, a translucent grey link will be used.
    • line
      • color (color or array of colors)
        default: "#444"
        Sets the color of the `line` around each `link`.
      • width (number or array of numbers greater than or equal to 0)
        default: 0
        Sets the width (in px) of the `line` around each `link`.
      • colorsrc
      • widthsrc
    • source (dataframe column, list, vector)
      default:
      An integer number `[0..nodes.length - 1]` that represents the source node.
    • target (dataframe column, list, vector)
      default:
      An integer number `[0..nodes.length - 1]` that represents the target node.
    • value (dataframe column, list, vector)
      default:
      A numeric value representing the flow volume value.
    • hoverinfo ( enumerated : "all" | "none" | "skip" )
      default: "all"
      Determines which trace information appear when hovering links. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
    • hoverlabel
      • bgcolor (color or array of colors)
        Sets the background color of the hover labels for this trace
      • bordercolor (color or array of colors)
        Sets the border color of the hover labels for this trace.
      • font
        Sets the font used in hover labels.
        • family (string or array of strings)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number or array of numbers greater than or equal to 1)
        • color (color or array of colors)
        • familysrc
        • sizesrc
        • colorsrc
      • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
        default: "auto"
        Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
      • namelength (integer or array of integers greater than or equal to -1)
        default: 15
        Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
      • bgcolorsrc
      • bordercolorsrc
      • alignsrc
      • namelengthsrc
    • hovertemplate (string or array of strings)
      default: ""
      Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. variables `value` and `label`. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
    • colorscales
      Each named list has one or more of the keys listed below.
      • label (string)
        default: ""
        The label of the links to color based on their concentration within a flow.
      • cmax (number)
        default: 1
        Sets the upper bound of the color domain.
      • cmin (number)
        default: 0
        Sets the lower bound of the color domain.
      • colorscale (colorscale)
        default: 0white1black
        Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • labelsrc
    • colorsrc
    • sourcesrc
    • targetsrc
    • valuesrc
    • hovertemplatesrc
  • idssrc
  • customdatasrc
  • metasrc

indicator
A indicator trace is initialized with plot_ly or add_trace:
plot_ly(df, type="indicator"[, ...])
add_trace(p, type="indicator"[, ...])
A indicator trace accepts any of the keys listed below.



  • type ("indicator")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • mode (flaglist string)
    Any combination of "number", "delta", "gauge" joined with a "+"
    examples: "number", "delta", "number+delta", "number+delta+gauge"
    default: "number"
    Determines how the value is displayed on the graph. `number` displays the value numerically in text. `delta` displays the difference to a reference value in text. Finally, `gauge` displays the value graphically on an axis.
  • value (number)
    Sets the number to be displayed.
  • align ( enumerated : "left" | "center" | "right" )
    Sets the horizontal alignment of the `text` within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered
  • domain
    • x (list)
      default: [0, 1]
      Sets the horizontal domain of this indicator trace (in plot fraction).
    • y (list)
      default: [0, 1]
      Sets the vertical domain of this indicator trace (in plot fraction).
    • row (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this row in the grid for this indicator trace .
    • column (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this column in the grid for this indicator trace .
  • title
    • text (string)
      Sets the title of this indicator.
    • align ( enumerated : "left" | "center" | "right" )
      Sets the horizontal alignment of the title. It defaults to `center` except for bullet charts for which it defaults to right.
    • font
      Set the font used to display the title
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
  • number
    • valueformat (string)
      default: ""
      Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
    • font
      Set the font used to display main number
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • prefix (string)
      default: ""
      Sets a prefix appearing before the number.
    • suffix (string)
      default: ""
      Sets a suffix appearing next to the number.
  • delta
    • reference (number)
      Sets the reference value to compute the delta. By default, it is set to the current value.
    • position ( enumerated : "top" | "bottom" | "left" | "right" )
      default: "bottom"
      Sets the position of delta with respect to the number.
    • relative (boolean)
      Show relative change
    • valueformat (string)
      Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
    • increasing
      • symbol (string)
        default: "â–²"
        Sets the symbol to display for increasing value
      • color (color)
        default: "#3D9970"
        Sets the color for increasing value.
    • decreasing
      • symbol (string)
        default: "â–¼"
        Sets the symbol to display for increasing value
      • color (color)
        default: "#FF4136"
        Sets the color for increasing value.
    • font
      Set the font used to display the delta
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
  • gauge
    The gauge of the Indicator plot.
    • shape ( enumerated : "angular" | "bullet" )
      default: "angular"
      Set the shape of the gauge
    • bar
      Set the appearance of the gauge's value
      • color (color)
        default: "green"
        Sets the background color of the arc.
      • line
        • color (color)
          default: "#444"
          Sets the color of the line enclosing each sector.
        • width (number greater than or equal to 0)
          default: 0
          Sets the width (in px) of the line enclosing each sector.
      • thickness (number between or equal to 0 and 1)
        default: 1
        Sets the thickness of the bar as a fraction of the total thickness of the gauge.
    • bgcolor (color)
      Sets the gauge background color.
    • bordercolor (color)
      default: "#444"
      Sets the color of the border enclosing the gauge.
    • borderwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the border enclosing the gauge.
    • axis
      • range (list)
        Sets the range of this axis.
      • visible (boolean)
        default: TRUE
        A single toggle to hide the axis while preserving interaction like dragging. Default is TRUE when a cheater plot is present on the axis, otherwise FALSE
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: "outside"
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • tickvalssrc
      • ticktextsrc
    • steps
      Each named list has one or more of the keys listed below.
      • color (color)
        Sets the background color of the arc.
      • line
        • color (color)
          default: "#444"
          Sets the color of the line enclosing each sector.
        • width (number greater than or equal to 0)
          default: 0
          Sets the width (in px) of the line enclosing each sector.
      • thickness (number between or equal to 0 and 1)
        default: 1
        Sets the thickness of the bar as a fraction of the total thickness of the gauge.
      • range (list)
        Sets the range of this axis.
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • threshold
      • line
        • color (color)
          default: "#444"
          Sets the color of the threshold line.
        • width (number greater than or equal to 0)
          default: 1
          Sets the width (in px) of the threshold line.
      • thickness (number between or equal to 0 and 1)
        default: 0.85
        Sets the thickness of the threshold line as a fraction of the thickness of the gauge.
      • value (number)
        Sets a treshold value drawn as a line.
  • idssrc
  • customdatasrc
  • metasrc

table
A table trace is initialized with plot_ly or add_trace:
plot_ly(df, type="table"[, ...])
add_trace(p, type="table"[, ...])
A table trace accepts any of the keys listed below.



  • type ("table")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • domain
    • x (list)
      default: [0, 1]
      Sets the horizontal domain of this table trace (in plot fraction).
    • y (list)
      default: [0, 1]
      Sets the vertical domain of this table trace (in plot fraction).
    • row (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this row in the grid for this table trace .
    • column (integer greater than or equal to 0)
      default: 0
      If there is a layout grid, use the domain for this column in the grid for this table trace .
  • columnwidth (number or array of numbers)
    The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.
  • columnorder (dataframe column, list, vector)
    Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column index `0` in the data will be rendered as the third column, as columns have an index base of zero.
  • header
    • values (dataframe column, list, vector)
      default:
      Header cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.
    • format (dataframe column, list, vector)
      default:
      Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
    • prefix (string or array of strings)
      Prefix for cell values.
    • suffix (string or array of strings)
      Suffix for cell values.
    • height (number)
      default: 28
      The height of cells.
    • align ( enumerated or array of enumerateds : "left" | "center" | "right" )
      default: "center"
      Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans more two or more lines (i.e. `text` contains one or more <br> HTML tags) or if an explicit width is set to override the text width.
    • line
    • fill
      • color (color or array of colors)
        default: "white"
        Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.
      • colorsrc
    • font
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • valuessrc
    • formatsrc
    • prefixsrc
    • suffixsrc
    • alignsrc
  • cells
    • values (dataframe column, list, vector)
      default:
      Cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.
    • format (dataframe column, list, vector)
      default:
      Sets the cell value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
    • prefix (string or array of strings)
      Prefix for cell values.
    • suffix (string or array of strings)
      Suffix for cell values.
    • height (number)
      default: 20
      The height of cells.
    • align ( enumerated or array of enumerateds : "left" | "center" | "right" )
      default: "center"
      Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans more two or more lines (i.e. `text` contains one or more <br> HTML tags) or if an explicit width is set to override the text width.
    • line
    • fill
      • color (color or array of colors)
        default: "white"
        Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.
      • colorsrc
    • font
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • valuessrc
    • formatsrc
    • prefixsrc
    • suffixsrc
    • alignsrc
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • columnwidthsrc
  • columnordersrc

carpet
A carpet trace is initialized with plot_ly or add_trace:
plot_ly(df, type="carpet"[, ...])
add_trace(p, type="carpet"[, ...])
A carpet trace accepts any of the keys listed below.



  • type ("carpet")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • carpet (string)
    An identifier for this carpet, so that `scattercarpet` and `scattercontour` traces can specify a carpet plot on which they lie
  • x (dataframe column, list, vector)
    A two dimensional array of x coordinates at each carpet point. If ommitted, the plot is a cheater plot and the xaxis is hidden by default.
  • y (dataframe column, list, vector)
    A two dimensional array of y coordinates at each carpet point.
  • a (dataframe column, list, vector)
    An array containing values of the first parameter value
  • a0 (number)
    default: 0
    Alternate to `a`. Builds a linear space of a coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step.
  • da (number)
    default: 1
    Sets the a coordinate step. See `a0` for more info.
  • b (dataframe column, list, vector)
    A two dimensional array of y coordinates at each carpet point.
  • b0 (number)
    default: 0
    Alternate to `b`. Builds a linear space of a coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step.
  • db (number)
    default: 1
    Sets the b coordinate step. See `b0` for more info.
  • cheaterslope (number)
    default: 1
    The shift applied to each successive row of data in creating a cheater plot. Only used if `x` is been ommitted.
  • aaxis
    • color (color)
      Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
    • title
      • text (string)
        default: ""
        Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this axis' title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • offset (number)
        default: 10
        An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated `titleoffset` attribute.
    • type ( enumerated : "-" | "linear" | "date" | "category" )
      default: "-"
      Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
    • autorange ( enumerated : TRUE | FALSE | "reversed" )
      default: TRUE
      Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "FALSE".
    • rangemode ( enumerated : "normal" | "tozero" | "nonnegative" )
      default: "normal"
      If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data.
    • range (list)
      Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
    • fixedrange (boolean)
      Determines whether or not this axis is zoom-able. If TRUE, then zoom is disabled.
    • cheatertype ( enumerated : "index" | "value" )
      default: "value"
    • tickmode ( enumerated : "linear" | "array" )
      default: "array"
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • showticklabels ( enumerated : "start" | "end" | "both" | "none" )
      default: "start"
      Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.
    • tickfont
      Sets the tick font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • categoryorder ( enumerated : "trace" | "category ascending" | "category descending" | "array" )
      default: "trace"
      Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`.
    • categoryarray (dataframe column, list, vector)
      Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
    • labelpadding (integer)
      default: 10
      Extra padding between label and the axis
    • labelprefix (string)
      Sets a axis label prefix.
    • labelsuffix (string)
      default: ""
      Sets a axis label suffix.
    • showline (boolean)
      Determines whether or not a line bounding this axis is drawn.
    • linecolor (color)
      default: "#444"
      Sets the axis line color.
    • linewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • gridcolor (color)
      Sets the axis line color.
    • gridwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • showgrid (boolean)
      default: TRUE
      Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
    • minorgridcount (integer greater than or equal to 0)
      default: 0
      Sets the number of minor grid ticks per major grid tick
    • minorgridwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the grid lines.
    • minorgridcolor (color)
      default: "#eee"
      Sets the color of the grid lines.
    • startline (boolean)
      Determines whether or not a line is drawn at along the starting value of this axis. If "TRUE", the start line is drawn on top of the grid lines.
    • startlinecolor (color)
      Sets the line color of the start line.
    • startlinewidth (number)
      default: 1
      Sets the width (in px) of the start line.
    • endline (boolean)
      Determines whether or not a line is drawn at along the final value of this axis. If "TRUE", the end line is drawn on top of the grid lines.
    • endlinewidth (number)
      default: 1
      Sets the width (in px) of the end line.
    • endlinecolor (color)
      Sets the line color of the end line.
    • tick0 (number greater than or equal to 0)
      default: 0
      The starting index of grid lines along the axis
    • dtick (number greater than or equal to 0)
      default: 1
      The stride between grid lines along the axis
    • arraytick0 (integer greater than or equal to 0)
      default: 0
      The starting index of grid lines along the axis
    • arraydtick (integer greater than or equal to 1)
      default: 1
      The stride between grid lines along the axis
    • tickvalssrc
    • ticktextsrc
    • categoryarraysrc
  • baxis
    • color (color)
      Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
    • title
      • text (string)
        default: ""
        Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this axis' title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • offset (number)
        default: 10
        An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated `titleoffset` attribute.
    • type ( enumerated : "-" | "linear" | "date" | "category" )
      default: "-"
      Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
    • autorange ( enumerated : TRUE | FALSE | "reversed" )
      default: TRUE
      Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "FALSE".
    • rangemode ( enumerated : "normal" | "tozero" | "nonnegative" )
      default: "normal"
      If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data.
    • range (list)
      Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
    • fixedrange (boolean)
      Determines whether or not this axis is zoom-able. If TRUE, then zoom is disabled.
    • cheatertype ( enumerated : "index" | "value" )
      default: "value"
    • tickmode ( enumerated : "linear" | "array" )
      default: "array"
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • showticklabels ( enumerated : "start" | "end" | "both" | "none" )
      default: "start"
      Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.
    • tickfont
      Sets the tick font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • categoryorder ( enumerated : "trace" | "category ascending" | "category descending" | "array" )
      default: "trace"
      Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`.
    • categoryarray (dataframe column, list, vector)
      Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
    • labelpadding (integer)
      default: 10
      Extra padding between label and the axis
    • labelprefix (string)
      Sets a axis label prefix.
    • labelsuffix (string)
      default: ""
      Sets a axis label suffix.
    • showline (boolean)
      Determines whether or not a line bounding this axis is drawn.
    • linecolor (color)
      default: "#444"
      Sets the axis line color.
    • linewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • gridcolor (color)
      Sets the axis line color.
    • gridwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • showgrid (boolean)
      default: TRUE
      Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
    • minorgridcount (integer greater than or equal to 0)
      default: 0
      Sets the number of minor grid ticks per major grid tick
    • minorgridwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the grid lines.
    • minorgridcolor (color)
      default: "#eee"
      Sets the color of the grid lines.
    • startline (boolean)
      Determines whether or not a line is drawn at along the starting value of this axis. If "TRUE", the start line is drawn on top of the grid lines.
    • startlinecolor (color)
      Sets the line color of the start line.
    • startlinewidth (number)
      default: 1
      Sets the width (in px) of the start line.
    • endline (boolean)
      Determines whether or not a line is drawn at along the final value of this axis. If "TRUE", the end line is drawn on top of the grid lines.
    • endlinewidth (number)
      default: 1
      Sets the width (in px) of the end line.
    • endlinecolor (color)
      Sets the line color of the end line.
    • tick0 (number greater than or equal to 0)
      default: 0
      The starting index of grid lines along the axis
    • dtick (number greater than or equal to 0)
      default: 1
      The stride between grid lines along the axis
    • arraytick0 (integer greater than or equal to 0)
      default: 0
      The starting index of grid lines along the axis
    • arraydtick (integer greater than or equal to 1)
      default: 1
      The stride between grid lines along the axis
    • tickvalssrc
    • ticktextsrc
    • categoryarraysrc
  • font
    The default font used for axis & tick labels on this carpet
    • family (string)
      default: ""Open Sans", verdana, arial, sans-serif"
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number greater than or equal to 1)
      default: 12
    • color (color)
      default: "#444"
  • color (color)
    default: "#444"
    Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • xsrc
  • ysrc
  • asrc
  • bsrc

scattercarpet
A scattercarpet trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scattercarpet"[, ...])
add_trace(p, type="scattercarpet"[, ...])
A scattercarpet trace accepts any of the keys listed below.



  • type ("scattercarpet")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • carpet (string)
    An identifier for this carpet, so that `scattercarpet` and `scattercontour` traces can specify a carpet plot on which they lie
  • a (dataframe column, list, vector)
    Sets the a-axis coordinates.
  • b (dataframe column, list, vector)
    Sets the b-axis coordinates.
  • mode (flaglist string)
    Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    default: "markers"
    Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace `hoverinfo` must contain a "text" flag.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: "solid"
      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • shape ( enumerated : "linear" | "spline" )
      default: "linear"
      Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape).
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • fill ( enumerated : "none" | "toself" | "tonext" )
    default: "none"
    Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterternary has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other.
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • marker
    • symbol ( enumerated or array of enumerateds : "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      default: "circle"
      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
    • opacity (number or array of numbers between or equal to 0 and 1)
      Sets the marker opacity.
    • maxdisplayed (number greater than or equal to 0)
      default: 0
      Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode ( enumerated : "diameter" | "area" )
      default: "diameter"
      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • line
      • width (number or array of numbers greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • widthsrc
      • colorsrc
    • gradient
      • type ( enumerated or array of enumerateds : "radial" | "horizontal" | "vertical" | "none" )
        default: "none"
        Sets the type of gradient used to fill the markers
      • color (color or array of colors)
        Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.
      • typesrc
      • colorsrc
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • symbolsrc
    • opacitysrc
    • sizesrc
    • colorsrc
  • textfont
    Sets the text font.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • textposition ( enumerated or array of enumerateds : "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    default: "middle center"
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • hoverinfo (flaglist string)
    Any combination of "a", "b", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "a", "b", "a+b", "a+b+text", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoveron (flaglist string)
    Any combination of "points", "fills" joined with a "+"
    examples: "points", "fills", "points+fills"
    Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points".
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • asrc
  • bsrc
  • textsrc
  • hovertextsrc
  • textpositionsrc
  • hoverinfosrc
  • hovertemplatesrc

contourcarpet
A contourcarpet trace is initialized with plot_ly or add_trace:
plot_ly(df, type="contourcarpet"[, ...])
add_trace(p, type="contourcarpet"[, ...])
A contourcarpet trace accepts any of the keys listed below.



  • type ("contourcarpet")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • carpet (string)
    The `carpet` of the carpet axes on which this contour trace lies
  • z (dataframe column, list, vector)
    Sets the z data.
  • a (dataframe column, list, vector)
    Sets the x coordinates.
  • a0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • da (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • b (dataframe column, list, vector)
    Sets the y coordinates.
  • b0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • db (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (dataframe column, list, vector)
    Sets the text elements associated with each z value.
  • hovertext (dataframe column, list, vector)
    Same as `text`.
  • transpose (boolean)
    Transposes the z data.
  • atype ( enumerated : "array" | "scaled" )
    If "array", the heatmap's x coordinates are given by "x" (the default behavior when `x` is provided). If "scaled", the heatmap's x coordinates are given by "x0" and "dx" (the default behavior when `x` is not provided).
  • btype ( enumerated : "array" | "scaled" )
    If "array", the heatmap's y coordinates are given by "y" (the default behavior when `y` is provided) If "scaled", the heatmap's y coordinates are given by "y0" and "dy" (the default behavior when `y` is not provided)
  • fillcolor (color)
    Sets the fill color if `contours.type` is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • autocontour (boolean)
    default: TRUE
    Determines whether or not the contour level attributes are picked by an algorithm. If "TRUE", the number of contour levels can be set in `ncontours`. If "FALSE", set the contour level attributes in `contours`.
  • ncontours (integer greater than or equal to 1)
    default: 15
    Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is "TRUE" or if `contours.size` is missing.
  • contours
    • type ( enumerated : "levels" | "constraint" )
      default: "levels"
      If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.
    • start (number)
      Sets the starting contour level value. Must be less than `contours.end`
    • end (number)
      Sets the end contour level value. Must be more than `contours.start`
    • size (number greater than or equal to 0)
      Sets the step between each contour level. Must be positive.
    • coloring ( enumerated : "fill" | "lines" | "none" )
      default: "fill"
      Determines the coloring method showing the contour values. If "fill", coloring is done evenly between each contour level If "lines", coloring is done on the contour lines. If "none", no coloring is applied on this trace.
    • showlines (boolean)
      default: TRUE
      Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill".
    • showlabels (boolean)
      Determines whether to label the contour lines with their values.
    • labelfont
      Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • labelformat (string)
      default: ""
      Sets the contour label formatting rule using d3 formatting mini-language which is very similar to Python, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format
    • operation ( enumerated : "=" | "<" | ">=" | ">" | "<=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")[" )
      default: "="
      Sets the constraint operation. "=" keeps regions equal to `value` "<" and "<=" keep regions less than `value` ">" and ">=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.
    • value (number or categorical coordinate string)
      default: 0
      Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) "value" is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.
  • line
    • color (color)
      Sets the color of the contour level. Has no if `contours.coloring` is set to "lines".
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: "solid"
      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Sets the amount of smoothing for the contour lines, where "0" corresponds to no smoothing.
  • zauto (boolean)
    default: TRUE
    Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `FALSE` when `zmin` and `zmax` are set by the user.
  • zmin (number)
    Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
  • zmax (number)
    Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
  • zmid (number)
    Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `FALSE`.
  • colorscale (colorscale)
    Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
  • autocolorscale (boolean)
    Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
  • reversescale (boolean)
    Reverses the color mapping if TRUE. If TRUE, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
  • showscale (boolean)
    default: TRUE
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode ( enumerated : "fraction" | "pixels" )
      default: "pixels"
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: "#444"
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: "#444"
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of padded area.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      default: ""
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the color bar's tick label font
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • title
      • text (string)
        Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • side ( enumerated : "right" | "top" | "bottom" )
        default: "top"
        Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
    • tickvalssrc
    • ticktextsrc
  • coloraxis (subplotid)
    Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • zsrc
  • asrc
  • bsrc
  • textsrc
  • hovertextsrc

ohlc
A ohlc trace is initialized with plot_ly or add_trace:
plot_ly(df, type="ohlc"[, ...])
add_trace(p, type="ohlc"[, ...])
A ohlc trace accepts any of the keys listed below.



  • type ("ohlc")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the x coordinates. If absent, linear coordinate will be generated.
  • open (dataframe column, list, vector)
    Sets the open values.
  • high (dataframe column, list, vector)
    Sets the high values.
  • low (dataframe column, list, vector)
    Sets the low values.
  • close (dataframe column, list, vector)
    Sets the close values.
  • line
    • width (number greater than or equal to 0)
      default: 2
      [object Object] Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.
    • dash (string)
      default: "solid"
      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). Note that this style setting can also be set per direction via `increasing.line.dash` and `decreasing.line.dash`.
  • increasing
    • line
      • color (color)
        default: "#3D9970"
        Sets the line color.
      • width (number greater than or equal to 0)
        default: 2
        Sets the line width (in px).
      • dash (string)
        default: "solid"
        Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
  • decreasing
    • line
      • color (color)
        default: "#FF4136"
        Sets the line color.
      • width (number greater than or equal to 0)
        default: 2
        Sets the line width (in px).
      • dash (string)
        default: "solid"
        Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
  • text (string or array of strings)
    default: ""
    Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • tickwidth (number between or equal to 0 and 0.5)
    default: 0.3
    Sets the width of the open/close tick marks relative to the "x" minimal interval.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • split (boolean)
      Show hover information (open, close, high, low) in separate labels.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • xsrc
  • opensrc
  • highsrc
  • lowsrc
  • closesrc
  • textsrc
  • hovertextsrc

candlestick
A candlestick trace is initialized with plot_ly or add_trace:
plot_ly(df, type="candlestick"[, ...])
add_trace(p, type="candlestick"[, ...])
A candlestick trace accepts any of the keys listed below.



  • type ("candlestick")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • x (dataframe column, list, vector)
    Sets the x coordinates. If absent, linear coordinate will be generated.
  • open (dataframe column, list, vector)
    Sets the open values.
  • high (dataframe column, list, vector)
    Sets the high values.
  • low (dataframe column, list, vector)
    Sets the low values.
  • close (dataframe column, list, vector)
    Sets the close values.
  • line
    • width (number greater than or equal to 0)
      default: 2
      Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.
  • increasing
    • line
      • color (color)
        default: "#3D9970"
        Sets the color of line bounding the box(es).
      • width (number greater than or equal to 0)
        default: 2
        Sets the width (in px) of line bounding the box(es).
    • fillcolor (color)
      Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • decreasing
    • line
      • color (color)
        default: "#FF4136"
        Sets the color of line bounding the box(es).
      • width (number greater than or equal to 0)
        default: 2
        Sets the width (in px) of line bounding the box(es).
    • fillcolor (color)
      Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • text (string or array of strings)
    default: ""
    Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • whiskerwidth (number between or equal to 0 and 1)
    default: 0
    Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • split (boolean)
      Show hover information (open, close, high, low) in separate labels.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • xcalendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the calendar system to use with `x` date data.
  • xaxis (subplotid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (subplotid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • xsrc
  • opensrc
  • highsrc
  • lowsrc
  • closesrc
  • textsrc
  • hovertextsrc

scatterpolar
A scatterpolar trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scatterpolar"[, ...])
add_trace(p, type="scatterpolar"[, ...])
A scatterpolar trace accepts any of the keys listed below.



  • type ("scatterpolar")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • mode (flaglist string)
    Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".
  • r (dataframe column, list, vector)
    Sets the radial coordinates
  • theta (dataframe column, list, vector)
    Sets the angular coordinates
  • r0 (number or categorical coordinate string)
    default: 0
    Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.
  • dr (number)
    default: 1
    Sets the r coordinate step.
  • theta0 (number or categorical coordinate string)
    default: 0
    Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.
  • dtheta (number)
    Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates.
  • thetaunit ( enumerated : "radians" | "degrees" | "gradians" )
    default: "degrees"
    Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes.
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: "solid"
      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • shape ( enumerated : "linear" | "spline" )
      default: "linear"
      Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape).
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • marker
    • symbol ( enumerated or array of enumerateds : "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      default: "circle"
      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
    • opacity (number or array of numbers between or equal to 0 and 1)
      Sets the marker opacity.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • maxdisplayed (number greater than or equal to 0)
      default: 0
      Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.
    • sizeref (number)
      default: 1
      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode ( enumerated : "diameter" | "area" )
      default: "diameter"
      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • line
      • width (number or array of numbers greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • widthsrc
      • colorsrc
    • gradient
      • type ( enumerated or array of enumerateds : "radial" | "horizontal" | "vertical" | "none" )
        default: "none"
        Sets the type of gradient used to fill the markers
      • color (color or array of colors)
        Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.
      • typesrc
      • colorsrc
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • symbolsrc
    • opacitysrc
    • sizesrc
    • colorsrc
  • cliponaxis (boolean)
    Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to "below traces".
  • textposition ( enumerated or array of enumerateds : "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    default: "middle center"
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • textfont
    Sets the text font.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • fill ( enumerated : "none" | "toself" | "tonext" )
    default: "none"
    Sets the area to fill with a solid color. Use with `fillcolor` if not "none". scatterpolar has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other.
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • hoverinfo (flaglist string)
    Any combination of "r", "theta", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "r", "theta", "r+theta", "r+theta+text", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoveron (flaglist string)
    Any combination of "points", "fills" joined with a "+"
    examples: "points", "fills", "points+fills"
    Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points".
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • subplot (subplotid)
    default: polar
    Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • rsrc
  • thetasrc
  • textsrc
  • hovertextsrc
  • textpositionsrc
  • hoverinfosrc
  • hovertemplatesrc

scatterpolargl
A scatterpolargl trace is initialized with plot_ly or add_trace:
plot_ly(df, type="scatterpolargl"[, ...])
add_trace(p, type="scatterpolargl"[, ...])
A scatterpolargl trace accepts any of the keys listed below.



  • type ("scatterpolargl")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • mode (flaglist string)
    Any combination of "lines", "markers", "text" joined with a "+" OR "none".
    examples: "lines", "markers", "lines+markers", "lines+markers+text", "none"
    Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".
  • r (dataframe column, list, vector)
    Sets the radial coordinates
  • theta (dataframe column, list, vector)
    Sets the angular coordinates
  • r0 (number or categorical coordinate string)
    default: 0
    Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.
  • dr (number)
    default: 1
    Sets the r coordinate step.
  • theta0 (number or categorical coordinate string)
    default: 0
    Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.
  • dtheta (number)
    Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates.
  • thetaunit ( enumerated : "radians" | "degrees" | "gradians" )
    default: "degrees"
    Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes.
  • text (string or array of strings)
    default: ""
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  • hovertext (string or array of strings)
    default: ""
    Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • shape ( enumerated : "linear" | "hv" | "vh" | "hvh" | "vhv" )
      default: "linear"
      Determines the line shape. The values correspond to step-wise line shapes.
    • dash ( enumerated : "solid" | "dot" | "dash" | "longdash" | "dashdot" | "longdashdot" )
      default: "solid"
      Sets the style of the lines.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • marker
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • symbol ( enumerated or array of enumerateds : "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      default: "circle"
      Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode ( enumerated : "diameter" | "area" )
      default: "diameter"
      Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • opacity (number or array of numbers between or equal to 0 and 1)
      Sets the marker opacity.
    • line
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • width (number or array of numbers greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorsrc
      • widthsrc
    • colorsrc
    • symbolsrc
    • sizesrc
    • opacitysrc
  • fill ( enumerated : "none" | "tozeroy" | "tozerox" | "tonexty" | "tonextx" | "toself" | "tonext" )
    default: "none"
    Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.
  • fillcolor (color)
    Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  • textposition ( enumerated or array of enumerateds : "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    default: "middle center"
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • textfont
    Sets the text font.
    • family (string or array of strings)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number or array of numbers greater than or equal to 1)
    • color (color or array of colors)
    • familysrc
    • sizesrc
    • colorsrc
  • hoverinfo (flaglist string)
    Any combination of "r", "theta", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "r", "theta", "r+theta", "r+theta+text", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
      • size (number greater than or equal to 0)
        Sets the marker size of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
      • size (number greater than or equal to 0)
        Sets the marker size of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • subplot (subplotid)
    default: polar
    Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • rsrc
  • thetasrc
  • textsrc
  • hovertextsrc
  • hovertemplatesrc
  • textpositionsrc
  • hoverinfosrc

barpolar
A barpolar trace is initialized with plot_ly or add_trace:
plot_ly(df, type="barpolar"[, ...])
add_trace(p, type="barpolar"[, ...])
A barpolar trace accepts any of the keys listed below.



  • type ("barpolar")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • selectedpoints (number or categorical coordinate string)
    Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • r (dataframe column, list, vector)
    Sets the radial coordinates
  • theta (dataframe column, list, vector)
    Sets the angular coordinates
  • r0 (number or categorical coordinate string)
    default: 0
    Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.
  • dr (number)
    default: 1
    Sets the r coordinate step.
  • theta0 (number or categorical coordinate string)
    default: 0
    Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.
  • dtheta (number)
    Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates.
  • thetaunit ( enumerated : "radians" | "degrees" | "gradians" )
    default: "degrees"
    Sets the unit of input "theta" values. Has an effect only when on "linear" angular axes.
  • base (number or categorical coordinate string)
    Sets where the bar base is drawn (in radial axis units). In "stack" barmode, traces that set "base" will be excluded and drawn in "overlay" mode instead.
  • offset (number or array of numbers)
    Shifts the angular position where the bar is drawn (in "thetatunit" units).
  • width (number or array of numbers greater than or equal to 0)
    Sets the bar angular width (in "thetaunit" units).
  • text (string or array of strings)
    default: ""
    Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.
  • hovertext (string or array of strings)
    default: ""
    Same as `text`.
  • marker
    • line
      • width (number or array of numbers greater than or equal to 0)
        default: 0
        Sets the width (in px) of the lines bounding the marker points.
      • color (color or array of colors)
        Sets themarker.linecolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.
      • cauto (boolean)
        default: TRUE
        Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color`is set to a numerical array. Defaults to `FALSE` when `marker.line.cmin` and `marker.line.cmax` are set by the user.
      • cmin (number)
        Sets the lower bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.
      • cmax (number)
        Sets the upper bound of the color domain. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.
      • cmid (number)
        Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color`is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `FALSE`.
      • colorscale (colorscale)
        Sets the colorscale. Has an effect only if in `marker.line.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
      • autocolorscale (boolean)
        default: TRUE
        Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
      • reversescale (boolean)
        Reverses the color mapping if TRUE. Has an effect only if in `marker.line.color`is set to a numerical array. If TRUE, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.
      • coloraxis (subplotid)
        Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
      • widthsrc
      • colorsrc
    • color (color or array of colors)
      Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `FALSE` when `marker.cmin` and `marker.cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. Has an effect only if in `marker.color`is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. Has an effect only if in `marker.color`is set to a numerical array. If TRUE, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    • showscale (boolean)
      Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
    • coloraxis (subplotid)
      Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
    • opacity (number or array of numbers between or equal to 0 and 1)
      default: 1
      Sets the opacity of the bars.
    • colorsrc
    • opacitysrc
  • hoverinfo (flaglist string)
    Any combination of "r", "theta", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "r", "theta", "r+theta", "r+theta+text", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hovertemplate (string or array of strings)
    default: ""
    Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: TRUE`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
  • selected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of selected points.
      • color (color)
        Sets the marker color of selected points.
    • textfont
      • color (color)
        Sets the text font color of selected points.
  • unselected
    • marker
      • opacity (number between or equal to 0 and 1)
        Sets the marker opacity of unselected points, applied only when a selection exists.
      • color (color)
        Sets the marker color of unselected points, applied only when a selection exists.
    • textfont
      • color (color)
        Sets the text font color of unselected points, applied only when a selection exists.
  • subplot (subplotid)
    default: polar
    Sets a reference between this trace's data coordinates and a polar subplot. If "polar" (the default value), the data refer to `layout.polar`. If "polar2", the data refer to `layout.polar2`, and so on.
  • idssrc
  • customdatasrc
  • metasrc
  • rsrc
  • thetasrc
  • basesrc
  • offsetsrc
  • widthsrc
  • textsrc
  • hovertextsrc
  • hoverinfosrc
  • hovertemplatesrc

area
A area trace is initialized with plot_ly or add_trace:
plot_ly(df, type="area"[, ...])
add_trace(p, type="area"[, ...])
A area trace accepts any of the keys listed below.



  • type ("area")
  • visible ( enumerated : TRUE | FALSE | "legendonly" )
    default: TRUE
    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: TRUE
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ""
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • ids (dataframe column, list, vector)
    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
  • customdata (dataframe column, list, vector)
    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements
  • meta (number or categorical coordinate string)
    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
  • hoverinfo (flaglist string)
    Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip".
    examples: "x", "y", "x+y", "x+y+z", "all"
    default: "all"
    Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
  • hoverlabel
    • bgcolor (color or array of colors)
      Sets the background color of the hover labels for this trace
    • bordercolor (color or array of colors)
      Sets the border color of the hover labels for this trace.
    • font
      Sets the font used in hover labels.
      • family (string or array of strings)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number or array of numbers greater than or equal to 1)
      • color (color or array of colors)
      • familysrc
      • sizesrc
      • colorsrc
    • align ( enumerated or array of enumerateds : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer or array of integers greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
    • bgcolorsrc
    • bordercolorsrc
    • alignsrc
    • namelengthsrc
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number between or equal to 0 and 10000)
      default: 500
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to "50", only the newest 50 points will be displayed on the plot.
  • transforms
    Each named list has one or more of the keys listed below.
  • uirevision (number or categorical coordinate string)
    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: TRUE` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: TRUE}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
  • r (dataframe column, list, vector)
    Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the radial coordinates for legacy polar chart only.
  • t (dataframe column, list, vector)
    Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the angular coordinates for legacy polar chart only.
  • marker
    • color (color or array of colors)
      Area traces are deprecated! Please switch to the "barpolar" trace type. Sets themarkercolor. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    • size (number or array of numbers greater than or equal to 0)
      default: 6
      Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the marker size (in px).
    • symbol ( enumerated or array of enumerateds : "0" | "circle" | "100" | "circle-open" | "200" | "circle-dot" | "300" | "circle-open-dot" | "1" | "square" | "101" | "square-open" | "201" | "square-dot" | "301" | "square-open-dot" | "2" | "diamond" | "102" | "diamond-open" | "202" | "diamond-dot" | "302" | "diamond-open-dot" | "3" | "cross" | "103" | "cross-open" | "203" | "cross-dot" | "303" | "cross-open-dot" | "4" | "x" | "104" | "x-open" | "204" | "x-dot" | "304" | "x-open-dot" | "5" | "triangle-up" | "105" | "triangle-up-open" | "205" | "triangle-up-dot" | "305" | "triangle-up-open-dot" | "6" | "triangle-down" | "106" | "triangle-down-open" | "206" | "triangle-down-dot" | "306" | "triangle-down-open-dot" | "7" | "triangle-left" | "107" | "triangle-left-open" | "207" | "triangle-left-dot" | "307" | "triangle-left-open-dot" | "8" | "triangle-right" | "108" | "triangle-right-open" | "208" | "triangle-right-dot" | "308" | "triangle-right-open-dot" | "9" | "triangle-ne" | "109" | "triangle-ne-open" | "209" | "triangle-ne-dot" | "309" | "triangle-ne-open-dot" | "10" | "triangle-se" | "110" | "triangle-se-open" | "210" | "triangle-se-dot" | "310" | "triangle-se-open-dot" | "11" | "triangle-sw" | "111" | "triangle-sw-open" | "211" | "triangle-sw-dot" | "311" | "triangle-sw-open-dot" | "12" | "triangle-nw" | "112" | "triangle-nw-open" | "212" | "triangle-nw-dot" | "312" | "triangle-nw-open-dot" | "13" | "pentagon" | "113" | "pentagon-open" | "213" | "pentagon-dot" | "313" | "pentagon-open-dot" | "14" | "hexagon" | "114" | "hexagon-open" | "214" | "hexagon-dot" | "314" | "hexagon-open-dot" | "15" | "hexagon2" | "115" | "hexagon2-open" | "215" | "hexagon2-dot" | "315" | "hexagon2-open-dot" | "16" | "octagon" | "116" | "octagon-open" | "216" | "octagon-dot" | "316" | "octagon-open-dot" | "17" | "star" | "117" | "star-open" | "217" | "star-dot" | "317" | "star-open-dot" | "18" | "hexagram" | "118" | "hexagram-open" | "218" | "hexagram-dot" | "318" | "hexagram-open-dot" | "19" | "star-triangle-up" | "119" | "star-triangle-up-open" | "219" | "star-triangle-up-dot" | "319" | "star-triangle-up-open-dot" | "20" | "star-triangle-down" | "120" | "star-triangle-down-open" | "220" | "star-triangle-down-dot" | "320" | "star-triangle-down-open-dot" | "21" | "star-square" | "121" | "star-square-open" | "221" | "star-square-dot" | "321" | "star-square-open-dot" | "22" | "star-diamond" | "122" | "star-diamond-open" | "222" | "star-diamond-dot" | "322" | "star-diamond-open-dot" | "23" | "diamond-tall" | "123" | "diamond-tall-open" | "223" | "diamond-tall-dot" | "323" | "diamond-tall-open-dot" | "24" | "diamond-wide" | "124" | "diamond-wide-open" | "224" | "diamond-wide-dot" | "324" | "diamond-wide-open-dot" | "25" | "hourglass" | "125" | "hourglass-open" | "26" | "bowtie" | "126" | "bowtie-open" | "27" | "circle-cross" | "127" | "circle-cross-open" | "28" | "circle-x" | "128" | "circle-x-open" | "29" | "square-cross" | "129" | "square-cross-open" | "30" | "square-x" | "130" | "square-x-open" | "31" | "diamond-cross" | "131" | "diamond-cross-open" | "32" | "diamond-x" | "132" | "diamond-x-open" | "33" | "cross-thin" | "133" | "cross-thin-open" | "34" | "x-thin" | "134" | "x-thin-open" | "35" | "asterisk" | "135" | "asterisk-open" | "36" | "hash" | "136" | "hash-open" | "236" | "hash-dot" | "336" | "hash-open-dot" | "37" | "y-up" | "137" | "y-up-open" | "38" | "y-down" | "138" | "y-down-open" | "39" | "y-left" | "139" | "y-left-open" | "40" | "y-right" | "140" | "y-right-open" | "41" | "line-ew" | "141" | "line-ew-open" | "42" | "line-ns" | "142" | "line-ns-open" | "43" | "line-ne" | "143" | "line-ne-open" | "44" | "line-nw" | "144" | "line-nw-open" )
      default: "circle"
      Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
    • opacity (number or array of numbers between or equal to 0 and 1)
      Area traces are deprecated! Please switch to the "barpolar" trace type. Sets the marker opacity.
    • colorsrc
    • sizesrc
    • symbolsrc
    • opacitysrc
  • idssrc
  • customdatasrc
  • metasrc
  • hoverinfosrc
  • rsrc
  • tsrc

layout
  • font
    Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.
    • family (string)
      default: ""Open Sans", verdana, arial, sans-serif"
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
    • size (number greater than or equal to 1)
      default: 12
    • color (color)
      default: "#444"
  • title
    • text (string)
      Sets the plot's title. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
    • font
      Sets the title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • xref ( enumerated : "container" | "paper" )
      default: "container"
      Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
    • yref ( enumerated : "container" | "paper" )
      default: "container"
      Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
    • x (number between or equal to 0 and 1)
      default: 0.5
      Sets the x position with respect to `xref` in normalized coordinates from "0" (left) to "1" (right).
    • y (number between or equal to 0 and 1)
      default: auto
      Sets the y position with respect to `yref` in normalized coordinates from "0" (bottom) to "1" (top). "auto" places the baseline of the title onto the vertical center of the top margin.
    • xanchor ( enumerated : "auto" | "left" | "center" | "right" )
      default: "auto"
      Sets the title's horizontal alignment with respect to its x position. "left" means that the title starts at x, "right" means that the title ends at x and "center" means that the title's center is at x. "auto" divides `xref` by three and calculates the `xanchor` value automatically based on the value of `x`.
    • yanchor ( enumerated : "auto" | "top" | "middle" | "bottom" )
      default: "auto"
      Sets the title's vertical alignment with respect to its y position. "top" means that the title's cap line is at y, "bottom" means that the title's baseline is at y and "middle" means that the title's midline is at y. "auto" divides `yref` by three and calculates the `yanchor` value automatically based on the value of `y`.
    • pad
      Sets the padding of the title. Each padding value only applies when the corresponding `xanchor`/`yanchor` value is set accordingly. E.g. for left padding to take effect, `xanchor` must be set to "left". The same rule applies if `xanchor`/`yanchor` is determined automatically. Padding is muted if the respective anchor value is "middle"/"center".
      • t (number)
        default: 0
        The amount of padding (in px) along the top of the component.
      • r (number)
        default: 0
        The amount of padding (in px) on the right side of the component.
      • b (number)
        default: 0
        The amount of padding (in px) along the bottom of the component.
      • l (number)
        default: 0
        The amount of padding (in px) on the left side of the component.
  • autosize (boolean)
    Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.
  • width (number greater than or equal to 10)
    default: 700
    Sets the plot's width (in px).
  • height (number greater than or equal to 10)
    default: 450
    Sets the plot's height (in px).
  • margin
    • l (number greater than or equal to 0)
      default: 80
      Sets the left margin (in px).
    • r (number greater than or equal to 0)
      default: 80
      Sets the right margin (in px).
    • t (number greater than or equal to 0)
      default: 100
      Sets the top margin (in px).
    • b (number greater than or equal to 0)
      default: 80
      Sets the bottom margin (in px).
    • pad (number greater than or equal to 0)
      default: 0
      Sets the amount of padding (in px) between the plotting area and the axis lines
    • autoexpand (boolean)
      default: TRUE
  • paper_bgcolor (color)
    default: "#fff"
    Sets the color of paper where the graph is drawn.
  • plot_bgcolor (color)
    default: "#fff"
    Sets the color of plotting area in-between x and y axes.
  • separators (string)
    Sets the decimal and thousand separators. For example, ". " puts a '.' before decimals and a space between thousands. In English locales, dflt is ".," but other locales may alter this default.
  • hidesources (boolean)
    Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the plotly service (at https://plot.ly or on-premise).
  • showlegend (boolean)
    Determines whether or not a legend is drawn. Default is `TRUE` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: TRUE`.
  • colorway (colorlist)
    default: #1f77b4#ff7f0e#2ca02c#d62728#9467bd#8c564b#e377c2#7f7f7f#bcbd22#17becf
    Sets the default trace colors.
  • datarevision (number or categorical coordinate string)
    If provided, a changed value tells `Plotly.react` that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, `Plotly.react` assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.
  • uirevision (number or categorical coordinate string)
    Used to allow user interactions with the plot to persist after `Plotly.react` calls that are unaware of these interactions. If `uirevision` is omitted, or if it is given and it changed from the previous `Plotly.react` call, the exact new figure is used. If `uirevision` is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. `layout.uirevision` attribute serves as the default for `uirevision` attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set `xaxis.uirevision="time"` and `yaxis.uirevision="cost"`. Then if only the y data is changed, you can update `yaxis.uirevision="quantity"` and the y axis range will reset but the x axis range will retain any user-driven zoom.
  • editrevision (number or categorical coordinate string)
    Controls persistence of user-driven changes in `editable: TRUE` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.
  • selectionrevision (number or categorical coordinate string)
    Controls persistence of user-driven changes in selected points from all traces.
  • template (number or categorical coordinate string)
    Default attributes to be applied to the plot. Templates can be created from existing plots using `Plotly.makeTemplate`, or created manually. They should be objects with format: `{layout: layoutTemplate, data: {[type]: [traceTemplate, ...]}, ...}` `layoutTemplate` and `traceTemplate` are objects matching the attribute structure of `layout` and a data trace. Trace templates are applied cyclically to traces of each type. Container arrays (eg `annotations`) have special handling: An object ending in `defaults` (eg `annotationdefaults`) is applied to each array item. But if an item has a `templateitemname` key we look in the template array for an item with matching `name` and apply that instead. If no matching `name` is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching `templateitemname` and `visible: FALSE`.
  • modebar
    • orientation ( enumerated : "v" | "h" )
      default: "h"
      Sets the orientation of the modebar.
    • bgcolor (color)
      Sets the background color of the modebar.
    • color (color)
      Sets the color of the icons in the modebar.
    • activecolor (color)
      Sets the color of the active or hovered on icons in the modebar.
    • uirevision (number or categorical coordinate string)
      Controls persistence of user-driven changes related to the modebar, including `hovermode`, `dragmode`, and `showspikes` at both the root level and inside subplots. Defaults to `layout.uirevision`.
  • meta (number or categorical coordinate string)
    Assigns extra meta information that can be used in various `text` attributes. Attributes such as the graph, axis and colorbar `title.text`, annotation `text` `trace.name` in legend items, `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. One can access `meta` fields using template strings: `%{meta[i]}` where `i` is the index of the `meta` item in question. `meta` can also be an object for example `{key: value}` which can be accessed %{meta[key]}.
  • transition
    Sets transition options used during Plotly.react updates.
    • duration (number greater than or equal to 0)
      default: 500
      The duration of the transition, in milliseconds. If equal to zero, updates are synchronous.
    • easing ( enumerated : "linear" | "quad" | "cubic" | "sin" | "exp" | "circle" | "elastic" | "back" | "bounce" | "linear-in" | "quad-in" | "cubic-in" | "sin-in" | "exp-in" | "circle-in" | "elastic-in" | "back-in" | "bounce-in" | "linear-out" | "quad-out" | "cubic-out" | "sin-out" | "exp-out" | "circle-out" | "elastic-out" | "back-out" | "bounce-out" | "linear-in-out" | "quad-in-out" | "cubic-in-out" | "sin-in-out" | "exp-in-out" | "circle-in-out" | "elastic-in-out" | "back-in-out" | "bounce-in-out" )
      default: "cubic-in-out"
      The easing function used for the transition
    • ordering ( enumerated : "layout first" | "traces first" )
      default: "layout first"
      Determines whether the figure's layout or traces smoothly transitions during updates that make both traces and layout change.
  • clickmode (flaglist string)
    Any combination of "event", "select" joined with a "+" OR "none".
    examples: "event", "select", "event+select", "none"
    default: "event"
    Determines the mode of single click interactions. "event" is the default value and emits the `plotly_click` event. In addition this mode emits the `plotly_selected` event in drag modes "lasso" and "select", but with no event data attached (kept for compatibility reasons). The "select" flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. "select" with `hovermode`: "x" can be confusing, consider explicitly setting `hovermode`: "closest" when using this feature. Selection events are sent accordingly as long as "event" flag is set as well. When the "event" flag is missing, `plotly_click` and `plotly_selected` events are not fired.
  • dragmode ( enumerated : "zoom" | "pan" | "select" | "lasso" | "orbit" | "turntable" | FALSE )
    default: "zoom"
    Determines the mode of drag interactions. "select" and "lasso" apply only to scatter traces with markers or text. "orbit" and "turntable" apply only to 3D scenes.
  • hovermode ( enumerated : "x" | "y" | "closest" | FALSE )
    Determines the mode of hover interactions. If `clickmode` includes the "select" flag, `hovermode` defaults to "closest". If `clickmode` lacks the "select" flag, it defaults to "x" or "y" (depending on the trace's `orientation` value) for plots based on cartesian coordinates. For anything else the default value is "closest".
  • hoverdistance (integer greater than or equal to -1)
    default: 20
    Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict.
  • spikedistance (integer greater than or equal to -1)
    default: 20
    Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.
  • hoverlabel
    • bgcolor (color)
      Sets the background color of all hover labels on graph
    • bordercolor (color)
      Sets the border color of all hover labels on graph.
    • font
      Sets the default hover label font used by all traces on the graph.
      • family (string)
        default: "Arial, sans-serif"
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
        default: 13
      • color (color)
    • align ( enumerated : "left" | "right" | "auto" )
      default: "auto"
      Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    • namelength (integer greater than or equal to -1)
      default: 15
      Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.
  • selectdirection ( enumerated : "h" | "v" | "d" | "any" )
    default: "any"
    When "dragmode" is set to "select", this limits the selection of the drag to horizontal, vertical or diagonal. "h" only allows horizontal selection, "v" only vertical, "d" only diagonal and "any" sets no limit.
  • grid
    • rows (integer greater than or equal to 1)
      The number of rows in the grid. If you provide a 2D `subplots` array or a `yaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.
    • roworder ( enumerated : "top to bottom" | "bottom to top" )
      default: "top to bottom"
      Is the first row the top or the bottom? Note that columns are always enumerated from left to right.
    • columns (integer greater than or equal to 1)
      The number of columns in the grid. If you provide a 2D `subplots` array, the length of its longest row is used as the default. If you give an `xaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.
    • subplots (list)
      Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support `domain` can place themselves in this grid separately using the `gridcell` attribute.
    • xaxes (list)
      Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs.
    • yaxes (list)
      Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs.
    • pattern ( enumerated : "independent" | "coupled" )
      default: "coupled"
      If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`, we can generate defaults using consecutive axis IDs, in two ways: "coupled" gives one x axis per column and one y axis per row. "independent" uses a new xy pair for each cell, left-to-right across each row then iterating rows according to `roworder`.
    • xgap (number between or equal to 0 and 1)
      Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids.
    • ygap (number between or equal to 0 and 1)
      Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids.
    • domain
      • x (list)
        default: [0, 1]
        Sets the horizontal domain of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges.
      • y (list)
        default: [0, 1]
        Sets the vertical domain of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges.
    • xside ( enumerated : "bottom" | "bottom plot" | "top plot" | "top" )
      default: "bottom plot"
      Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar.
    • yside ( enumerated : "left" | "left plot" | "right plot" | "right" )
      default: "left plot"
      Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar.
  • calendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
    default: "gregorian"
    Sets the default calendar system to use for interpreting and displaying dates throughout the plot.
  • xaxis
    • visible (boolean)
      A single toggle to hide the axis while preserving interaction like dragging. Default is TRUE when a cheater plot is present on the axis, otherwise FALSE
    • color (color)
      default: "#444"
      Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
    • title
      • text (string)
        Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
    • type ( enumerated : "-" | "linear" | "log" | "date" | "category" | "multicategory" )
      default: "-"
      Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
    • autorange ( enumerated : TRUE | FALSE | "reversed" )
      default: TRUE
      Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "FALSE".
    • rangemode ( enumerated : "normal" | "tozero" | "nonnegative" )
      default: "normal"
      If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.
    • range (list)
      Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
    • fixedrange (boolean)
      Determines whether or not this axis is zoom-able. If TRUE, then zoom is disabled.
    • scaleanchor ( enumerated : "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. `constrain` and `constraintoward` determine how we enforce the constraint. You can chain these, ie `yaxis: {scaleanchor: "x"}, xaxis2: {scaleanchor: "y"}` but you can only link axes of the same `type`. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (`yaxis: {scaleanchor: "x"}, xaxis: {scaleanchor: "y"}` or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via `scaleratio`. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden.
    • scaleratio (number greater than or equal to 0)
      default: 1
      If this axis is linked to another by `scaleanchor`, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.
    • constrain ( enumerated : "range" | "domain" )
      default: "range"
      If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the "range" (default), or by decreasing the "domain".
    • constraintoward ( enumerated : "left" | "center" | "right" | "top" | "middle" | "bottom" )
      If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines which direction we push the originally specified plot area. Options are "left", "center" (default), and "right" for x axes, and "top", "middle" (default), and "bottom" for y axes.
    • matches ( enumerated : "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      If set to another axis id (e.g. `x2`, `y`), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Moreover, note that matching axes must have the same `type`.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • tickson ( enumerated : "labels" | "boundaries" )
      default: "labels"
      Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of `type` "category" or "multicategory". When set to "boundaries", ticks and grid lines are drawn half a category to the left/bottom of labels.
    • mirror ( enumerated : TRUE | "ticks" | FALSE | "all" | "allticks" )
      Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "TRUE", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "FALSE", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • automargin (boolean)
      Determines whether long tick labels automatically grow the figure margins.
    • showspikes (boolean)
      Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest
    • spikecolor (color)
      Sets the spike color. If undefined, will use the series color
    • spikethickness (number)
      default: 3
      Sets the width (in px) of the zero line.
    • spikedash (string)
      default: "dash"
      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • spikemode (flaglist string)
      Any combination of "toaxis", "across", "marker" joined with a "+"
      examples: "toaxis", "across", "toaxis+across", "toaxis+across+marker"
      default: "toaxis"
      Determines the drawing mode for the spike line If "toaxis", the line is drawn from the data point to the axis the series is plotted on. If "across", the line is drawn across the entire plot area, and supercedes "toaxis". If "marker", then a marker dot is drawn on the axis the series is plotted on
    • spikesnap ( enumerated : "data" | "cursor" )
      default: "data"
      Determines whether spikelines are stuck to the cursor or to the closest datapoints.
    • tickfont
      Sets the tick font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • hoverformat (string)
      default: ""
      Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • showline (boolean)
      Determines whether or not a line bounding this axis is drawn.
    • linecolor (color)
      default: "#444"
      Sets the axis line color.
    • linewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • showgrid (boolean)
      Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
    • gridcolor (color)
      default: "#eee"
      Sets the color of the grid lines.
    • gridwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the grid lines.
    • zeroline (boolean)
      Determines whether or not a line is drawn at along the 0 value of this axis. If "TRUE", the zero line is drawn on top of the grid lines.
    • zerolinecolor (color)
      default: "#444"
      Sets the line color of the zero line.
    • zerolinewidth (number)
      default: 1
      Sets the width (in px) of the zero line.
    • showdividers (boolean)
      default: TRUE
      Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on "multicategory" axes.
    • dividercolor (color)
      default: "#444"
      Sets the color of the dividers Only has an effect on "multicategory" axes.
    • dividerwidth (number)
      default: 1
      Sets the width (in px) of the dividers Only has an effect on "multicategory" axes.
    • anchor ( enumerated : "free" | "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`.
    • side ( enumerated : "top" | "bottom" | "left" | "right" )
      Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area.
    • overlaying ( enumerated : "free" | "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "FALSE", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.
    • layer ( enumerated : "above traces" | "below traces" )
      default: "above traces"
      Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "FALSE" to show markers and/or text nodes above this axis.
    • domain (list)
      default: [0, 1]
      Sets the domain of this axis (in plot fraction).
    • position (number between or equal to 0 and 1)
      default: 0
      Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free".
    • categoryorder ( enumerated : "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
      default: "trace"
      Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
    • categoryarray (dataframe column, list, vector)
      Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
    • uirevision (number or categorical coordinate string)
      Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: TRUE` configuration. Defaults to `layout.uirevision`.
    • rangeslider
      • bgcolor (color)
        default: "#fff"
        Sets the background color of the range slider.
      • bordercolor (color)
        default: "#444"
        Sets the border color of the range slider.
      • borderwidth (integer greater than or equal to 0)
        default: 0
        Sets the border width of the range slider.
      • autorange (boolean)
        default: TRUE
        Determines whether or not the range slider range is computed in relation to the input data. If `range` is provided, then `autorange` is set to "FALSE".
      • range (list)
        Sets the range of the range slider. If not set, defaults to the full xaxis range. If the axis `type` is "log", then you must take the log of your desired range. If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
      • thickness (number between or equal to 0 and 1)
        default: 0.15
        The height of the range slider as a fraction of the total plot area height.
      • visible (boolean)
        default: TRUE
        Determines whether or not the range slider will be visible. If visible, perpendicular axes will be set to `fixedrange`
      • yaxis
        • rangemode ( enumerated : "auto" | "fixed" | "match" )
          default: "match"
          Determines whether or not the range of this axis in the rangeslider use the same value than in the main plot when zooming in/out. If "auto", the autorange will be used. If "fixed", the `range` is used. If "match", the current range of the corresponding y-axis on the main subplot is used.
        • range (list)
          Sets the range of this axis for the rangeslider.
    • rangeselector
      • visible (boolean)
        Determines whether or not this range selector is visible. Note that range selectors are only available for x axes of `type` set to or auto-typed to "date".
      • buttons
        Each named list has one or more of the keys listed below.
        • visible (boolean)
          default: TRUE
          Determines whether or not this button is visible.
        • step ( enumerated : "month" | "year" | "day" | "hour" | "minute" | "second" | "all" )
          default: "month"
          The unit of measurement that the `count` value will set the range by.
        • stepmode ( enumerated : "backward" | "todate" )
          default: "backward"
          Sets the range update mode. If "backward", the range update shifts the start of range back "count" times "step" milliseconds. If "todate", the range update shifts the start of range back to the first timestamp from "count" times "step" milliseconds back. For example, with `step` set to "year" and `count` set to "1" the range update shifts the start of the range back to January 01 of the current year. Month and year "todate" are currently available only for the built-in (Gregorian) calendar.
        • count (number greater than or equal to 0)
          default: 1
          Sets the number of steps to take to update the range. Use with `step` to specify the update interval.
        • label (string)
          Sets the text label to appear on the button.
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • x (number between or equal to -2 and 3)
        Sets the x position (in normalized coordinates) of the range selector.
      • xanchor ( enumerated : "auto" | "left" | "center" | "right" )
        default: "left"
        Sets the range selector's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the range selector.
      • y (number between or equal to -2 and 3)
        Sets the y position (in normalized coordinates) of the range selector.
      • yanchor ( enumerated : "auto" | "top" | "middle" | "bottom" )
        default: "bottom"
        Sets the range selector's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the range selector.
      • font
        Sets the font of the range selector button text.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • bgcolor (color)
        default: "#eee"
        Sets the background color of the range selector buttons.
      • activecolor (color)
        Sets the background color of the active range selector button.
      • bordercolor (color)
        default: "#444"
        Sets the color of the border enclosing the range selector.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) of the border enclosing the range selector.
    • calendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
      default: "gregorian"
      Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`
    • tickvalssrc
    • ticktextsrc
    • categoryarraysrc
  • yaxis
    • visible (boolean)
      A single toggle to hide the axis while preserving interaction like dragging. Default is TRUE when a cheater plot is present on the axis, otherwise FALSE
    • color (color)
      default: "#444"
      Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
    • title
      • text (string)
        Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
      • font
        Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
    • type ( enumerated : "-" | "linear" | "log" | "date" | "category" | "multicategory" )
      default: "-"
      Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
    • autorange ( enumerated : TRUE | FALSE | "reversed" )
      default: TRUE
      Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "FALSE".
    • rangemode ( enumerated : "normal" | "tozero" | "nonnegative" )
      default: "normal"
      If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.
    • range (list)
      Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
    • fixedrange (boolean)
      Determines whether or not this axis is zoom-able. If TRUE, then zoom is disabled.
    • scaleanchor ( enumerated : "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      If set to another axis id (e.g. `x2`, `y`), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. `constrain` and `constraintoward` determine how we enforce the constraint. You can chain these, ie `yaxis: {scaleanchor: "x"}, xaxis2: {scaleanchor: "y"}` but you can only link axes of the same `type`. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (`yaxis: {scaleanchor: "x"}, xaxis: {scaleanchor: "y"}` or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via `scaleratio`. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden.
    • scaleratio (number greater than or equal to 0)
      default: 1
      If this axis is linked to another by `scaleanchor`, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.
    • constrain ( enumerated : "range" | "domain" )
      default: "range"
      If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the "range" (default), or by decreasing the "domain".
    • constraintoward ( enumerated : "left" | "center" | "right" | "top" | "middle" | "bottom" )
      If this axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines which direction we push the originally specified plot area. Options are "left", "center" (default), and "right" for x axes, and "top", "middle" (default), and "bottom" for y axes.
    • matches ( enumerated : "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      If set to another axis id (e.g. `x2`, `y`), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a `scaleanchor` and a `matches` constraint is currently forbidden. Moreover, note that matching axes must have the same `type`.
    • tickmode ( enumerated : "auto" | "linear" | "array" )
      Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
    • tick0 (number or categorical coordinate string)
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
    • dtick (number or categorical coordinate string)
      Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
    • tickvals (dataframe column, list, vector)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
    • ticktext (dataframe column, list, vector)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
    • ticks ( enumerated : "outside" | "inside" | "" )
      Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
    • tickson ( enumerated : "labels" | "boundaries" )
      default: "labels"
      Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of `type` "category" or "multicategory". When set to "boundaries", ticks and grid lines are drawn half a category to the left/bottom of labels.
    • mirror ( enumerated : TRUE | "ticks" | FALSE | "all" | "allticks" )
      Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "TRUE", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "FALSE", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: "#444"
      Sets the tick color.
    • showticklabels (boolean)
      default: TRUE
      Determines whether or not the tick labels are drawn.
    • automargin (boolean)
      Determines whether long tick labels automatically grow the figure margins.
    • showspikes (boolean)
      Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest
    • spikecolor (color)
      Sets the spike color. If undefined, will use the series color
    • spikethickness (number)
      default: 3
      Sets the width (in px) of the zero line.
    • spikedash (string)
      default: "dash"
      Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • spikemode (flaglist string)
      Any combination of "toaxis", "across", "marker" joined with a "+"
      examples: "toaxis", "across", "toaxis+across", "toaxis+across+marker"
      default: "toaxis"
      Determines the drawing mode for the spike line If "toaxis", the line is drawn from the data point to the axis the series is plotted on. If "across", the line is drawn across the entire plot area, and supercedes "toaxis". If "marker", then a marker dot is drawn on the axis the series is plotted on
    • spikesnap ( enumerated : "data" | "cursor" )
      default: "data"
      Determines whether spikelines are stuck to the cursor or to the closest datapoints.
    • tickfont
      Sets the tick font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickprefix (string)
      default: ""
      Sets a tick label prefix.
    • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
    • ticksuffix (string)
      default: ""
      Sets a tick label suffix.
    • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      Same as `showtickprefix` but for tick suffixes.
    • showexponent ( enumerated : "all" | "first" | "last" | "none" )
      default: "all"
      If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
    • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
      default: "B"
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
    • separatethousands (boolean)
      If "TRUE", even 4-digit integers are separated
    • tickformat (string)
      default: ""
      Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • tickformatstops
      Each named list has one or more of the keys listed below.
      • enabled (boolean)
        default: TRUE
        Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
      • dtickrange (list)
        range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
      • value (string)
        default: ""
        string - dtickformat for described zoom level, the same as "tickformat"
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • hoverformat (string)
      default: ""
      Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
    • showline (boolean)
      Determines whether or not a line bounding this axis is drawn.
    • linecolor (color)
      default: "#444"
      Sets the axis line color.
    • linewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • showgrid (boolean)
      Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
    • gridcolor (color)
      default: "#eee"
      Sets the color of the grid lines.
    • gridwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the grid lines.
    • zeroline (boolean)
      Determines whether or not a line is drawn at along the 0 value of this axis. If "TRUE", the zero line is drawn on top of the grid lines.
    • zerolinecolor (color)
      default: "#444"
      Sets the line color of the zero line.
    • zerolinewidth (number)
      default: 1
      Sets the width (in px) of the zero line.
    • showdividers (boolean)
      default: TRUE
      Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on "multicategory" axes.
    • dividercolor (color)
      default: "#444"
      Sets the color of the dividers Only has an effect on "multicategory" axes.
    • dividerwidth (number)
      default: 1
      Sets the width (in px) of the dividers Only has an effect on "multicategory" axes.
    • anchor ( enumerated : "free" | "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`.
    • side ( enumerated : "top" | "bottom" | "left" | "right" )
      Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area.
    • overlaying ( enumerated : "free" | "/^x([2-9]|[1-9][0-9]+)?$/" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "FALSE", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.
    • layer ( enumerated : "above traces" | "below traces" )
      default: "above traces"
      Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "FALSE" to show markers and/or text nodes above this axis.
    • domain (list)
      default: [0, 1]
      Sets the domain of this axis (in plot fraction).
    • position (number between or equal to 0 and 1)
      default: 0
      Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free".
    • categoryorder ( enumerated : "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
      default: "trace"
      Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
    • categoryarray (dataframe column, list, vector)
      Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
    • uirevision (number or categorical coordinate string)
      Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: TRUE` configuration. Defaults to `layout.uirevision`.
    • calendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
      default: "gregorian"
      Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`
    • tickvalssrc
    • ticktextsrc
    • categoryarraysrc
  • ternary
    • domain
      • x (list)
        default: [0, 1]
        Sets the horizontal domain of this ternary subplot (in plot fraction).
      • y (list)
        default: [0, 1]
        Sets the vertical domain of this ternary subplot (in plot fraction).
      • row (integer greater than or equal to 0)
        default: 0
        If there is a layout grid, use the domain for this row in the grid for this ternary subplot .
      • column (integer greater than or equal to 0)
        default: 0
        If there is a layout grid, use the domain for this column in the grid for this ternary subplot .
    • bgcolor (color)
      default: "#fff"
      Set the background color of the subplot
    • sum (number greater than or equal to 0)
      default: 1
      The number each triplet should sum to, and the maximum range of each axis
    • aaxis
      • title
        • text (string)
          Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
      • color (color)
        default: "#444"
        Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 1)
        default: 6
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • hoverformat (string)
        default: ""
        Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • showline (boolean)
        default: TRUE
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: "#444"
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        default: TRUE
        Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: "#eee"
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • layer ( enumerated : "above traces" | "below traces" )
        default: "above traces"
        Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "FALSE" to show markers and/or text nodes above this axis.
      • min (number greater than or equal to 0)
        default: 0
        The minimum value visible on this axis. The maximum is determined by the sum minus the minimum values of the other two axes. The full view corresponds to all the minima set to zero.
      • uirevision (number or categorical coordinate string)
        Controls persistence of user-driven changes in axis `min`, and `title` if in `editable: TRUE` configuration. Defaults to `ternary<N>.uirevision`.
      • tickvalssrc
      • ticktextsrc
    • baxis
      • title
        • text (string)
          Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
      • color (color)
        default: "#444"
        Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 1)
        default: 6
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • hoverformat (string)
        default: ""
        Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • showline (boolean)
        default: TRUE
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: "#444"
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        default: TRUE
        Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: "#eee"
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • layer ( enumerated : "above traces" | "below traces" )
        default: "above traces"
        Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "FALSE" to show markers and/or text nodes above this axis.
      • min (number greater than or equal to 0)
        default: 0
        The minimum value visible on this axis. The maximum is determined by the sum minus the minimum values of the other two axes. The full view corresponds to all the minima set to zero.
      • uirevision (number or categorical coordinate string)
        Controls persistence of user-driven changes in axis `min`, and `title` if in `editable: TRUE` configuration. Defaults to `ternary<N>.uirevision`.
      • tickvalssrc
      • ticktextsrc
    • caxis
      • title
        • text (string)
          Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
      • color (color)
        default: "#444"
        Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 1)
        default: 6
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • hoverformat (string)
        default: ""
        Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • showline (boolean)
        default: TRUE
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: "#444"
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        default: TRUE
        Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: "#eee"
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • layer ( enumerated : "above traces" | "below traces" )
        default: "above traces"
        Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "FALSE" to show markers and/or text nodes above this axis.
      • min (number greater than or equal to 0)
        default: 0
        The minimum value visible on this axis. The maximum is determined by the sum minus the minimum values of the other two axes. The full view corresponds to all the minima set to zero.
      • uirevision (number or categorical coordinate string)
        Controls persistence of user-driven changes in axis `min`, and `title` if in `editable: TRUE` configuration. Defaults to `ternary<N>.uirevision`.
      • tickvalssrc
      • ticktextsrc
    • uirevision (number or categorical coordinate string)
      Controls persistence of user-driven changes in axis `min` and `title`, if not overridden in the individual axes. Defaults to `layout.uirevision`.
  • scene
    • _arrayAttrRegexps
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
    • camera
      • up
        Sets the (x,y,z) components of the 'up' camera vector. This vector determines the up direction of this scene with respect to the page. The default is "{x: 0, y: 0, z: 1}" which means that the z axis points up.
        • x (number)
          default: 0
        • y (number)
          default: 0
        • z (number)
          default: 1
      • center
        Sets the (x,y,z) components of the 'center' camera vector This vector determines the translation (x,y,z) space about the center of this scene. By default, there is no such translation.
        • x (number)
          default: 0
        • y (number)
          default: 0
        • z (number)
          default: 0
      • eye
        Sets the (x,y,z) components of the 'eye' camera vector. This vector determines the view point about the origin of this scene.
        • x (number)
          default: 1.25
        • y (number)
          default: 1.25
        • z (number)
          default: 1.25
      • projection
        • type ( enumerated : "perspective" | "orthographic" )
          default: "perspective"
          Sets the projection type. The projection type could be either "perspective" or "orthographic". The default is "perspective".
    • domain
      • x (list)
        default: [0, 1]
        Sets the horizontal domain of this scene subplot (in plot fraction).
      • y (list)
        default: [0, 1]
        Sets the vertical domain of this scene subplot (in plot fraction).
      • row (integer greater than or equal to 0)
        default: 0
        If there is a layout grid, use the domain for this row in the grid for this scene subplot .
      • column (integer greater than or equal to 0)
        default: 0
        If there is a layout grid, use the domain for this column in the grid for this scene subplot .
    • aspectmode ( enumerated : "auto" | "cube" | "data" | "manual" )
      default: "auto"
      If "cube", this scene's axes are drawn as a cube, regardless of the axes' ranges. If "data", this scene's axes are drawn in proportion with the axes' ranges. If "manual", this scene's axes are drawn in proportion with the input of "aspectratio" (the default behavior if "aspectratio" is provided). If "auto", this scene's axes are drawn using the results of "data" except when one axis is more than four times the size of the two others, where in that case the results of "cube" are used.
    • aspectratio
      Sets this scene's axis aspectratio.
      • x (number greater than or equal to 0)
      • y (number greater than or equal to 0)
      • z (number greater than or equal to 0)
    • xaxis
      • visible (boolean)
        A single toggle to hide the axis while preserving interaction like dragging. Default is TRUE when a cheater plot is present on the axis, otherwise FALSE
      • showspikes (boolean)
        default: TRUE
        Sets whether or not spikes starting from data points to this axis' wall are shown on hover.
      • spikesides (boolean)
        default: TRUE
        Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.
      • spikethickness (number greater than or equal to 0)
        default: 2
        Sets the thickness (in px) of the spikes.
      • spikecolor (color)
        default: "#444"
        Sets the color of the spikes.
      • showbackground (boolean)
        Sets whether or not this axis' wall has a background color.
      • backgroundcolor (color)
        default: "rgba(204, 204, 204, 0.5)"
        Sets the background color of this axis' wall.
      • showaxeslabels (boolean)
        default: TRUE
        Sets whether or not this axis is labeled
      • color (color)
        default: "#444"
        Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
      • categoryorder ( enumerated : "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
        default: "trace"
        Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
      • categoryarray (dataframe column, list, vector)
        Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
      • title
        • text (string)
          Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
      • type ( enumerated : "-" | "linear" | "log" | "date" | "category" )
        default: "-"
        Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
      • autorange ( enumerated : TRUE | FALSE | "reversed" )
        default: TRUE
        Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "FALSE".
      • rangemode ( enumerated : "normal" | "tozero" | "nonnegative" )
        default: "normal"
        If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.
      • range (list)
        Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • mirror ( enumerated : TRUE | "ticks" | FALSE | "all" | "allticks" )
        Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "TRUE", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "FALSE", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • hoverformat (string)
        default: ""
        Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • showline (boolean)
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: "#444"
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: "rgb(204, 204, 204)"
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • zeroline (boolean)
        Determines whether or not a line is drawn at along the 0 value of this axis. If "TRUE", the zero line is drawn on top of the grid lines.
      • zerolinecolor (color)
        default: "#444"
        Sets the line color of the zero line.
      • zerolinewidth (number)
        default: 1
        Sets the width (in px) of the zero line.
      • calendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
        default: "gregorian"
        Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`
      • categoryarraysrc
      • tickvalssrc
      • ticktextsrc
    • yaxis
      • visible (boolean)
        A single toggle to hide the axis while preserving interaction like dragging. Default is TRUE when a cheater plot is present on the axis, otherwise FALSE
      • showspikes (boolean)
        default: TRUE
        Sets whether or not spikes starting from data points to this axis' wall are shown on hover.
      • spikesides (boolean)
        default: TRUE
        Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.
      • spikethickness (number greater than or equal to 0)
        default: 2
        Sets the thickness (in px) of the spikes.
      • spikecolor (color)
        default: "#444"
        Sets the color of the spikes.
      • showbackground (boolean)
        Sets whether or not this axis' wall has a background color.
      • backgroundcolor (color)
        default: "rgba(204, 204, 204, 0.5)"
        Sets the background color of this axis' wall.
      • showaxeslabels (boolean)
        default: TRUE
        Sets whether or not this axis is labeled
      • color (color)
        default: "#444"
        Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
      • categoryorder ( enumerated : "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
        default: "trace"
        Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
      • categoryarray (dataframe column, list, vector)
        Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
      • title
        • text (string)
          Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
      • type ( enumerated : "-" | "linear" | "log" | "date" | "category" )
        default: "-"
        Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
      • autorange ( enumerated : TRUE | FALSE | "reversed" )
        default: TRUE
        Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "FALSE".
      • rangemode ( enumerated : "normal" | "tozero" | "nonnegative" )
        default: "normal"
        If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.
      • range (list)
        Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • mirror ( enumerated : TRUE | "ticks" | FALSE | "all" | "allticks" )
        Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "TRUE", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "FALSE", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • hoverformat (string)
        default: ""
        Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • showline (boolean)
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: "#444"
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: "rgb(204, 204, 204)"
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • zeroline (boolean)
        Determines whether or not a line is drawn at along the 0 value of this axis. If "TRUE", the zero line is drawn on top of the grid lines.
      • zerolinecolor (color)
        default: "#444"
        Sets the line color of the zero line.
      • zerolinewidth (number)
        default: 1
        Sets the width (in px) of the zero line.
      • calendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
        default: "gregorian"
        Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`
      • categoryarraysrc
      • tickvalssrc
      • ticktextsrc
    • zaxis
      • visible (boolean)
        A single toggle to hide the axis while preserving interaction like dragging. Default is TRUE when a cheater plot is present on the axis, otherwise FALSE
      • showspikes (boolean)
        default: TRUE
        Sets whether or not spikes starting from data points to this axis' wall are shown on hover.
      • spikesides (boolean)
        default: TRUE
        Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.
      • spikethickness (number greater than or equal to 0)
        default: 2
        Sets the thickness (in px) of the spikes.
      • spikecolor (color)
        default: "#444"
        Sets the color of the spikes.
      • showbackground (boolean)
        Sets whether or not this axis' wall has a background color.
      • backgroundcolor (color)
        default: "rgba(204, 204, 204, 0.5)"
        Sets the background color of this axis' wall.
      • showaxeslabels (boolean)
        default: TRUE
        Sets whether or not this axis is labeled
      • color (color)
        default: "#444"
        Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
      • categoryorder ( enumerated : "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
        default: "trace"
        Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
      • categoryarray (dataframe column, list, vector)
        Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
      • title
        • text (string)
          Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
      • type ( enumerated : "-" | "linear" | "log" | "date" | "category" )
        default: "-"
        Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
      • autorange ( enumerated : TRUE | FALSE | "reversed" )
        default: TRUE
        Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "FALSE".
      • rangemode ( enumerated : "normal" | "tozero" | "nonnegative" )
        default: "normal"
        If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes.
      • range (list)
        Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • mirror ( enumerated : TRUE | "ticks" | FALSE | "all" | "allticks" )
        Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "TRUE", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "FALSE", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • hoverformat (string)
        default: ""
        Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • showline (boolean)
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: "#444"
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: "rgb(204, 204, 204)"
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • zeroline (boolean)
        Determines whether or not a line is drawn at along the 0 value of this axis. If "TRUE", the zero line is drawn on top of the grid lines.
      • zerolinecolor (color)
        default: "#444"
        Sets the line color of the zero line.
      • zerolinewidth (number)
        default: 1
        Sets the width (in px) of the zero line.
      • calendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
        default: "gregorian"
        Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`
      • categoryarraysrc
      • tickvalssrc
      • ticktextsrc
    • dragmode ( enumerated : "orbit" | "turntable" | "zoom" | "pan" | FALSE )
      Determines the mode of drag interactions for this scene.
    • hovermode ( enumerated : "closest" | FALSE )
      default: "closest"
      Determines the mode of hover interactions for this scene.
    • uirevision (number or categorical coordinate string)
      Controls persistence of user-driven changes in camera attributes. Defaults to `layout.uirevision`.
    • annotations
      Each named list has one or more of the keys listed below.
      An annotation is a text element that can be placed anywhere in the plot. It can be positioned with respect to relative coordinates in the plot or with respect to the actual data coordinates of the graph. Annotations can be shown with or without an arrow.
      • visible (boolean)
        default: TRUE
        Determines whether or not this annotation is visible.
      • x (number or categorical coordinate string)
        Sets the annotation's x position.
      • y (number or categorical coordinate string)
        Sets the annotation's y position.
      • z (number or categorical coordinate string)
        Sets the annotation's z position.
      • ax (number)
        Sets the x component of the arrow tail about the arrow head (in pixels).
      • ay (number)
        Sets the y component of the arrow tail about the arrow head (in pixels).
      • xanchor ( enumerated : "auto" | "left" | "center" | "right" )
        default: "auto"
        Sets the text box's horizontal position anchor This anchor binds the `x` position to the "left", "center" or "right" of the annotation. For example, if `x` is set to 1, `xref` to "paper" and `xanchor` to "right" then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If "auto", the anchor is equivalent to "center" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.
      • xshift (number)
        default: 0
        Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.
      • yanchor ( enumerated : "auto" | "top" | "middle" | "bottom" )
        default: "auto"
        Sets the text box's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the annotation. For example, if `y` is set to 1, `yref` to "paper" and `yanchor` to "top" then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If "auto", the anchor is equivalent to "middle" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.
      • yshift (number)
        default: 0
        Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.
      • text (string)
        Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported.
      • textangle (angle)
        default: 0
        Sets the angle at which the `text` is drawn with respect to the horizontal.
      • font
        Sets the annotation text font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • width (number greater than or equal to 1)
        Sets an explicit width for the text box. null (default) lets the text set the box width. Wider text will be clipped. There is no automatic wrapping; use <br> to start a new line.
      • height (number greater than or equal to 1)
        Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the opacity of the annotation (text + arrow).
      • align ( enumerated : "left" | "center" | "right" )
        default: "center"
        Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans more two or more lines (i.e. `text` contains one or more <br> HTML tags) or if an explicit width is set to override the text width.
      • valign ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets the vertical alignment of the `text` within the box. Has an effect only if an explicit height is set to override the text height.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the background color of the annotation.
      • bordercolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of the border enclosing the annotation `text`.
      • borderpad (number greater than or equal to 0)
        default: 1
        Sets the padding (in px) between the `text` and the enclosing border.
      • borderwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the border enclosing the annotation `text`.
      • showarrow (boolean)
        default: TRUE
        Determines whether or not the annotation is drawn with an arrow. If "TRUE", `text` is placed near the arrow's tail. If "FALSE", `text` lines up with the `x` and `y` provided.
      • arrowcolor (color)
        Sets the color of the annotation arrow.
      • arrowhead (integer between or equal to 0 and 8)
        default: 1
        Sets the end annotation arrow head style.
      • startarrowhead (integer between or equal to 0 and 8)
        default: 1
        Sets the start annotation arrow head style.
      • arrowside (flaglist string)
        Any combination of "end", "start" joined with a "+" OR "none".
        examples: "end", "start", "end+start", "none"
        default: "end"
        Sets the annotation arrow head position.
      • arrowsize (number greater than or equal to 0.3)
        default: 1
        Sets the size of the end annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.
      • startarrowsize (number greater than or equal to 0.3)
        default: 1
        Sets the size of the start annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.
      • arrowwidth (number greater than or equal to 0.1)
        Sets the width (in px) of annotation arrow line.
      • standoff (number greater than or equal to 0)
        default: 0
        Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.
      • startstandoff (number greater than or equal to 0)
        default: 0
        Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.
      • hovertext (string)
        Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear.
      • hoverlabel
        • bgcolor (color)
          Sets the background color of the hover label. By default uses the annotation's `bgcolor` made opaque, or white if it was transparent.
        • bordercolor (color)
          Sets the border color of the hover label. By default uses either dark grey or white, for maximum contrast with `hoverlabel.bgcolor`.
        • font
          Sets the hover label text font. By default uses the global hover font and size, with color from `hoverlabel.bordercolor`.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
      • captureevents (boolean)
        Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation. By default `captureevents` is "FALSE" unless `hovertext` is provided. If you use the event `plotly_clickannotation` without `hovertext` you must explicitly enable `captureevents`.
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
  • geo
    • domain
      • x (list)
        default: [0, 1]
        Sets the horizontal domain of this geo subplot (in plot fraction). Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.
      • y (list)
        default: [0, 1]
        Sets the vertical domain of this geo subplot (in plot fraction). Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.
      • row (integer greater than or equal to 0)
        default: 0
        If there is a layout grid, use the domain for this row in the grid for this geo subplot . Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.
      • column (integer greater than or equal to 0)
        default: 0
        If there is a layout grid, use the domain for this column in the grid for this geo subplot . Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.
    • resolution ( enumerated : "110" | "50" )
      default: "110"
      Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.
    • scope ( enumerated : "world" | "usa" | "europe" | "asia" | "africa" | "north america" | "south america" )
      default: "world"
      Set the scope of the map.
    • projection
      • type ( enumerated : "equirectangular" | "mercator" | "orthographic" | "natural earth" | "kavrayskiy7" | "miller" | "robinson" | "eckert4" | "azimuthal equal area" | "azimuthal equidistant" | "conic equal area" | "conic conformal" | "conic equidistant" | "gnomonic" | "stereographic" | "mollweide" | "hammer" | "transverse mercator" | "albers usa" | "winkel tripel" | "aitoff" | "sinusoidal" )
        Sets the projection type.
      • rotation
        • lon (number)
          Rotates the map along parallels (in degrees East). Defaults to the center of the `lonaxis.range` values.
        • lat (number)
          Rotates the map along meridians (in degrees North).
        • roll (number)
          Roll the map (in degrees) For example, a roll of "180" makes the map appear upside down.
      • parallels (list)
        For conic projection types only. Sets the parallels (tangent, secant) where the cone intersects the sphere.
      • scale (number greater than or equal to 0)
        default: 1
        Zooms in or out on the map view. A scale of "1" corresponds to the largest zoom level that fits the map's lon and lat ranges.
    • center
      • lon (number)
        Sets the longitude of the map's center. By default, the map's longitude center lies at the middle of the longitude range for scoped projection and above `projection.rotation.lon` otherwise.
      • lat (number)
        Sets the latitude of the map's center. For all projection types, the map's latitude center lies at the middle of the latitude range by default.
    • showcoastlines (boolean)
      Sets whether or not the coastlines are drawn.
    • coastlinecolor (color)
      default: "#444"
      Sets the coastline color.
    • coastlinewidth (number greater than or equal to 0)
      default: 1
      Sets the coastline stroke width (in px).
    • showland (boolean)
      Sets whether or not land masses are filled in color.
    • landcolor (color)
      default: "#F0DC82"
      Sets the land mass color.
    • showocean (boolean)
      Sets whether or not oceans are filled in color.
    • oceancolor (color)
      default: "#3399FF"
      Sets the ocean color
    • showlakes (boolean)
      Sets whether or not lakes are drawn.
    • lakecolor (color)
      default: "#3399FF"
      Sets the color of the lakes.
    • showrivers (boolean)
      Sets whether or not rivers are drawn.
    • rivercolor (color)
      default: "#3399FF"
      Sets color of the rivers.
    • riverwidth (number greater than or equal to 0)
      default: 1
      Sets the stroke width (in px) of the rivers.
    • showcountries (boolean)
      Sets whether or not country boundaries are drawn.
    • countrycolor (color)
      default: "#444"
      Sets line color of the country boundaries.
    • countrywidth (number greater than or equal to 0)
      default: 1
      Sets line width (in px) of the country boundaries.
    • showsubunits (boolean)
      Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.
    • subunitcolor (color)
      default: "#444"
      Sets the color of the subunits boundaries.
    • subunitwidth (number greater than or equal to 0)
      default: 1
      Sets the stroke width (in px) of the subunits boundaries.
    • showframe (boolean)
      Sets whether or not a frame is drawn around the map.
    • framecolor (color)
      default: "#444"
      Sets the color the frame.
    • framewidth (number greater than or equal to 0)
      default: 1
      Sets the stroke width (in px) of the frame.
    • bgcolor (color)
      default: "#fff"
      Set the background color of the map
    • lonaxis
      • range (list)
        Sets the range of this axis (in degrees), sets the map's clipped coordinates.
      • showgrid (boolean)
        Sets whether or not graticule are shown on the map.
      • tick0 (number)
        default: 0
        Sets the graticule's starting tick longitude/latitude.
      • dtick (number)
        Sets the graticule's longitude/latitude tick step.
      • gridcolor (color)
        default: "#eee"
        Sets the graticule's stroke color.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the graticule's stroke width (in px).
    • lataxis
      • range (list)
        Sets the range of this axis (in degrees), sets the map's clipped coordinates.
      • showgrid (boolean)
        Sets whether or not graticule are shown on the map.
      • tick0 (number)
        default: 0
        Sets the graticule's starting tick longitude/latitude.
      • dtick (number)
        Sets the graticule's longitude/latitude tick step.
      • gridcolor (color)
        default: "#eee"
        Sets the graticule's stroke color.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the graticule's stroke width (in px).
    • uirevision (number or categorical coordinate string)
      Controls persistence of user-driven changes in the view (projection and center). Defaults to `layout.uirevision`.
  • mapbox
    • _arrayAttrRegexps
    • domain
      • x (list)
        default: [0, 1]
        Sets the horizontal domain of this mapbox subplot (in plot fraction).
      • y (list)
        default: [0, 1]
        Sets the vertical domain of this mapbox subplot (in plot fraction).
      • row (integer greater than or equal to 0)
        default: 0
        If there is a layout grid, use the domain for this row in the grid for this mapbox subplot .
      • column (integer greater than or equal to 0)
        default: 0
        If there is a layout grid, use the domain for this column in the grid for this mapbox subplot .
    • accesstoken (string)
      Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under `mapboxAccessToken`. Note that accessToken are only required when `style` (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server.
    • style (number or categorical coordinate string)
      default: basic
      Defines the map layers that are rendered by default below the trace layers defined in `data`, which are themselves by default rendered below the layers defined in `layout.mapbox.layers`. These layers can be defined either explicitly as a Mapbox Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes which do not require any access tokens, or by using a default Mapbox style or custom Mapbox style URL, both of which require a Mapbox access token Note that Mapbox access token can be set in the `accesstoken` attribute or in the `mapboxAccessToken` config option. Mapbox Style objects are of the form described in the Mapbox GL JS documentation available at https://docs.mapbox.com/mapbox-gl-js/style-spec The built-in plotly.js styles objects are: open-street-map, white-bg, carto-positron, carto-darkmatter, stamen-terrain, stamen-toner, stamen-watercolor The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox-<name>-<version>
    • center
      • lon (number)
        default: 0
        Sets the longitude of the center of the map (in degrees East).
      • lat (number)
        default: 0
        Sets the latitude of the center of the map (in degrees North).
    • zoom (number)
      default: 1
      Sets the zoom level of the map (mapbox.zoom).
    • bearing (number)
      default: 0
      Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).
    • pitch (number)
      default: 0
      Sets the pitch angle of the map (in degrees, where "0" means perpendicular to the surface of the map) (mapbox.pitch).
    • layers
      Each named list has one or more of the keys listed below.
      • visible (boolean)
        default: TRUE
        Determines whether this layer is displayed
      • sourcetype ( enumerated : "geojson" | "vector" | "raster" | "image" )
        default: "geojson"
        Sets the source type for this layer, that is the type of the layer data.
      • source (number or categorical coordinate string)
        Sets the source data for this layer (mapbox.layer.source). When `sourcetype` is set to "geojson", `source` can be a URL to a GeoJSON or a GeoJSON object. When `sourcetype` is set to "vector" or "raster", `source` can be a URL or an array of tile URLs. When `sourcetype` is set to "image", `source` can be a URL to an image.
      • sourcelayer (string)
        default: ""
        Specifies the layer to use from a vector tile source (mapbox.layer.source-layer). Required for "vector" source type that supports multiple layers.
      • sourceattribution (string)
        Sets the attribution for this source.
      • type ( enumerated : "circle" | "line" | "fill" | "symbol" | "raster" )
        default: "circle"
        Sets the layer type, that is the how the layer data set in `source` will be rendered With `sourcetype` set to "geojson", the following values are allowed: "circle", "line", "fill" and "symbol". but note that "line" and "fill" are not compatible with Point GeoJSON geometries. With `sourcetype` set to "vector", the following values are allowed: "circle", "line", "fill" and "symbol". With `sourcetype` set to "raster" or `"image"`, only the "raster" value is allowed.
      • coordinates (number or categorical coordinate string)
        Sets the coordinates array contains [longitude, latitude] pairs for the image corners listed in clockwise order: top left, top right, bottom right, bottom left. Only has an effect for "image" `sourcetype`.
      • below (string)
        Determines if the layer will be inserted before the layer with the specified ID. If omitted or set to '', the layer will be inserted above every existing layer.
      • color (color)
        default: "#444"
        Sets the primary layer color. If `type` is "circle", color corresponds to the circle color (mapbox.layer.paint.circle-color) If `type` is "line", color corresponds to the line color (mapbox.layer.paint.line-color) If `type` is "fill", color corresponds to the fill color (mapbox.layer.paint.fill-color) If `type` is "symbol", color corresponds to the icon color (mapbox.layer.paint.icon-color)
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the opacity of the layer. If `type` is "circle", opacity corresponds to the circle opacity (mapbox.layer.paint.circle-opacity) If `type` is "line", opacity corresponds to the line opacity (mapbox.layer.paint.line-opacity) If `type` is "fill", opacity corresponds to the fill opacity (mapbox.layer.paint.fill-opacity) If `type` is "symbol", opacity corresponds to the icon/text opacity (mapbox.layer.paint.text-opacity)
      • minzoom (number between or equal to 0 and 24)
        default: 0
        Sets the minimum zoom level (mapbox.layer.minzoom). At zoom levels less than the minzoom, the layer will be hidden.
      • maxzoom (number between or equal to 0 and 24)
        default: 24
        Sets the maximum zoom level (mapbox.layer.maxzoom). At zoom levels equal to or greater than the maxzoom, the layer will be hidden.
      • circle
        • radius (number)
          default: 15
          Sets the circle radius (mapbox.layer.paint.circle-radius). Has an effect only when `type` is set to "circle".
      • line
        • width (number)
          default: 2
          Sets the line width (mapbox.layer.paint.line-width). Has an effect only when `type` is set to "line".
        • dash (dataframe column, list, vector)
          Sets the length of dashes and gaps (mapbox.layer.paint.line-dasharray). Has an effect only when `type` is set to "line".
        • dashsrc
      • fill
        • outlinecolor (color)
          default: "#444"
          Sets the fill outline color (mapbox.layer.paint.fill-outline-color). Has an effect only when `type` is set to "fill".
      • symbol
        • icon (string)
          default: "marker"
          Sets the symbol icon image (mapbox.layer.layout.icon-image). Full list: https://www.mapbox.com/maki-icons/
        • iconsize (number)
          default: 10
          Sets the symbol icon size (mapbox.layer.layout.icon-size). Has an effect only when `type` is set to "symbol".
        • text (string)
          default: ""
          Sets the symbol text (mapbox.layer.layout.text-field).
        • placement ( enumerated : "point" | "line" | "line-center" )
          default: "point"
          Sets the symbol and/or text placement (mapbox.layer.layout.symbol-placement). If `placement` is "point", the label is placed where the geometry is located If `placement` is "line", the label is placed along the line of the geometry If `placement` is "line-center", the label is placed on the center of the geometry
        • textfont
          Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.layer.layout.text-size). Has an effect only when `type` is set to "symbol".
          • family (string)
            default: "Open Sans Regular, Arial Unicode MS Regular"
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • textposition ( enumerated : "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
          default: "middle center"
          Sets the positions of the `text` elements with respects to the (x,y) coordinates.
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • uirevision (number or categorical coordinate string)
      Controls persistence of user-driven changes in the view: `center`, `zoom`, `bearing`, `pitch`. Defaults to `layout.uirevision`.
  • polar
    • domain
      • x (list)
        default: [0, 1]
        Sets the horizontal domain of this polar subplot (in plot fraction).
      • y (list)
        default: [0, 1]
        Sets the vertical domain of this polar subplot (in plot fraction).
      • row (integer greater than or equal to 0)
        default: 0
        If there is a layout grid, use the domain for this row in the grid for this polar subplot .
      • column (integer greater than or equal to 0)
        default: 0
        If there is a layout grid, use the domain for this column in the grid for this polar subplot .
    • sector (list)
      default: [0, 360]
      Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the counterclockwise direction with "0" corresponding to rightmost limit of the polar subplot.
    • hole (number between or equal to 0 and 1)
      default: 0
      Sets the fraction of the radius to cut out of the polar subplot.
    • bgcolor (color)
      default: "#fff"
      Set the background color of the subplot
    • radialaxis
      • visible (boolean)
        default: TRUE
        A single toggle to hide the axis while preserving interaction like dragging. Default is TRUE when a cheater plot is present on the axis, otherwise FALSE
      • type ( enumerated : "-" | "linear" | "log" | "date" | "category" )
        default: "-"
        Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
      • autorange ( enumerated : TRUE | FALSE | "reversed" )
        default: TRUE
        Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to "FALSE".
      • rangemode ( enumerated : "tozero" | "nonnegative" | "normal" )
        default: "tozero"
        If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. If "normal", the range is computed in relation to the extrema of the input data (same behavior as for cartesian axes).
      • range (list)
        Sets the range of this axis. If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
      • categoryorder ( enumerated : "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
        default: "trace"
        Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
      • categoryarray (dataframe column, list, vector)
        Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
      • angle (angle)
        Sets the angle (in degrees) from which the radial axis is drawn. Note that by default, radial axis line on the theta=0 line corresponds to a line pointing right (like what mathematicians prefer). Defaults to the first `polar.sector` angle.
      • side ( enumerated : "clockwise" | "counterclockwise" )
        default: "clockwise"
        Determines on which side of radial axis line the tick and tick labels appear.
      • title
        • text (string)
          default: ""
          Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
      • hoverformat (string)
        default: ""
        Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • uirevision (number or categorical coordinate string)
        Controls persistence of user-driven changes in axis `range`, `autorange`, `angle`, and `title` if in `editable: TRUE` configuration. Defaults to `polar<N>.uirevision`.
      • color (color)
        default: "#444"
        Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
      • showline (boolean)
        default: TRUE
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: "#444"
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        default: TRUE
        Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: "#eee"
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • layer ( enumerated : "above traces" | "below traces" )
        default: "above traces"
        Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "FALSE" to show markers and/or text nodes above this axis.
      • calendar ( enumerated : "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" )
        default: "gregorian"
        Sets the calendar system to use for `range` and `tick0` if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global `layout.calendar`
      • categoryarraysrc
      • tickvalssrc
      • ticktextsrc
    • angularaxis
      • visible (boolean)
        default: TRUE
        A single toggle to hide the axis while preserving interaction like dragging. Default is TRUE when a cheater plot is present on the axis, otherwise FALSE
      • type ( enumerated : "-" | "linear" | "category" )
        default: "-"
        Sets the angular axis type. If "linear", set `thetaunit` to determine the unit in which axis value are shown. If "category, use `period` to set the number of integer coordinates around polar axis.
      • categoryorder ( enumerated : "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" )
        default: "trace"
        Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
      • categoryarray (dataframe column, list, vector)
        Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
      • thetaunit ( enumerated : "radians" | "degrees" )
        default: "degrees"
        Sets the format unit of the formatted "theta" values. Has an effect only when `angularaxis.type` is "linear".
      • period (number greater than or equal to 0)
        Set the angular period. Has an effect only when `angularaxis.type` is "category".
      • direction ( enumerated : "counterclockwise" | "clockwise" )
        default: "counterclockwise"
        Sets the direction corresponding to positive angles.
      • rotation (angle)
        Sets that start position (in degrees) of the angular axis By default, polar subplots with `direction` set to "counterclockwise" get a `rotation` of "0" which corresponds to due East (like what mathematicians prefer). In turn, polar with `direction` set to "clockwise" get a rotation of "90" which corresponds to due North (like on a compass),
      • hoverformat (string)
        default: ""
        Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • uirevision (number or categorical coordinate string)
        Controls persistence of user-driven changes in axis `rotation`. Defaults to `polar<N>.uirevision`.
      • color (color)
        default: "#444"
        Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
      • showline (boolean)
        default: TRUE
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: "#444"
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        default: TRUE
        Determines whether or not grid lines are drawn. If "TRUE", the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: "#eee"
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • layer ( enumerated : "above traces" | "below traces" )
        default: "above traces"
        Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with `cliponaxis` set to "FALSE" to show markers and/or text nodes above this axis.
      • categoryarraysrc
      • tickvalssrc
      • ticktextsrc
    • gridshape ( enumerated : "circular" | "linear" )
      default: "circular"
      Determines if the radial axis grid lines and angular axis line are drawn as "circular" sectors or as "linear" (polygon) sectors. Has an effect only when the angular axis has `type` "category". Note that `radialaxis.angle` is snapped to the angle of the closest vertex when `gridshape` is "circular" (so that radial axis scale is the same as the data scale).
    • uirevision (number or categorical coordinate string)
      Controls persistence of user-driven changes in axis attributes, if not overridden in the individual axes. Defaults to `layout.uirevision`.
  • radialaxis
    • range (list)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Defines the start and end point of this radial axis.
    • domain (list)
      default: [0, 1]
      Polar chart subplots are not supported yet. This key has currently no effect.
    • orientation (number)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the orientation (an angle with respect to the origin) of the radial axis.
    • showline (boolean)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the line bounding this radial axis will be shown on the figure.
    • showticklabels (boolean)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the radial axis ticks will feature tick labels.
    • tickorientation ( enumerated : "horizontal" | "vertical" )
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the orientation (from the paper perspective) of the radial axis tick labels.
    • ticklen (number greater than or equal to 0)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this radial axis.
    • tickcolor (color)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the color of the tick lines on this radial axis.
    • ticksuffix (string)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this radial axis.
    • endpadding (number)
      Legacy polar charts are deprecated! Please switch to "polar" subplots.
    • visible (boolean)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not this axis will be visible.
  • angularaxis
    • range (list)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Defines the start and end point of this angular axis.
    • domain (list)
      default: [0, 1]
      Polar chart subplots are not supported yet. This key has currently no effect.
    • showline (boolean)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the line bounding this angular axis will be shown on the figure.
    • showticklabels (boolean)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not the angular axis ticks will feature tick labels.
    • tickorientation ( enumerated : "horizontal" | "vertical" )
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the orientation (from the paper perspective) of the angular axis tick labels.
    • ticklen (number greater than or equal to 0)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this angular axis.
    • tickcolor (color)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the color of the tick lines on this angular axis.
    • ticksuffix (string)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the length of the tick lines on this angular axis.
    • endpadding (number)
      Legacy polar charts are deprecated! Please switch to "polar" subplots.
    • visible (boolean)
      Legacy polar charts are deprecated! Please switch to "polar" subplots. Determines whether or not this axis will be visible.
  • direction ( enumerated : "clockwise" | "counterclockwise" )
    Legacy polar charts are deprecated! Please switch to "polar" subplots. Sets the direction corresponding to positive angles in legacy polar charts.
  • orientation (angle)
    Legacy polar charts are deprecated! Please switch to "polar" subplots. Rotates the entire polar by the given angle in legacy polar charts.
  • legend
    • bgcolor (color)
      Sets the legend background color.
    • bordercolor (color)
      default: "#444"
      Sets the color of the border enclosing the legend.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) of the border enclosing the legend.
    • font
      Sets the font used to text the legend items.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • orientation ( enumerated : "v" | "h" )
      default: "v"
      Sets the orientation of the legend.
    • traceorder (flaglist string)
      Any combination of "reversed", "grouped" joined with a "+" OR "normal".
      examples: "reversed", "grouped", "reversed+grouped", "normal"
      Determines the order at which the legend items are displayed. If "normal", the items are displayed top-to-bottom in the same order as the input data. If "reversed", the items are displayed in the opposite order as "normal". If "grouped", the items are displayed in groups (when a trace `legendgroup` is provided). if "grouped+reversed", the items are displayed in the opposite order as "grouped".
    • tracegroupgap (number greater than or equal to 0)
      default: 10
      Sets the amount of vertical space (in px) between legend groups.
    • itemsizing ( enumerated : "trace" | "constant" )
      default: "trace"
      Determines if the legend items symbols scale with their corresponding "trace" attributes or remain "constant" independent of the symbol size on the graph.
    • itemclick ( enumerated : "toggle" | "toggleothers" | FALSE )
      default: "toggle"
      Determines the behavior on legend item click. "toggle" toggles the visibility of the item clicked on the graph. "toggleothers" makes the clicked item the sole visible item on the graph. "FALSE" disable legend item click interactions.
    • itemdoubleclick ( enumerated : "toggle" | "toggleothers" | FALSE )
      default: "toggleothers"
      Determines the behavior on legend item double-click. "toggle" toggles the visibility of the item clicked on the graph. "toggleothers" makes the clicked item the sole visible item on the graph. "FALSE" disable legend item double-click interactions.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position (in normalized coordinates) of the legend.
    • xanchor ( enumerated : "auto" | "left" | "center" | "right" )
      default: "left"
      Sets the legend's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the legend.
    • y (number between or equal to -2 and 3)
      default: 1
      Sets the y position (in normalized coordinates) of the legend.
    • yanchor ( enumerated : "auto" | "top" | "middle" | "bottom" )
      default: "auto"
      Sets the legend's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the legend.
    • uirevision (number or categorical coordinate string)
      Controls persistence of legend-driven changes in trace and pie label visibility. Defaults to `layout.uirevision`.
    • valign ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets the vertical alignment of the symbols with respect to their associated text.
  • annotations
    Each named list has one or more of the keys listed below.
    An annotation is a text element that can be placed anywhere in the plot. It can be positioned with respect to relative coordinates in the plot or with respect to the actual data coordinates of the graph. Annotations can be shown with or without an arrow.
    • visible (boolean)
      default: TRUE
      Determines whether or not this annotation is visible.
    • text (string)
      Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported.
    • textangle (angle)
      default: 0
      Sets the angle at which the `text` is drawn with respect to the horizontal.
    • font
      Sets the annotation text font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • width (number greater than or equal to 1)
      Sets an explicit width for the text box. null (default) lets the text set the box width. Wider text will be clipped. There is no automatic wrapping; use <br> to start a new line.
    • height (number greater than or equal to 1)
      Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped.
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the opacity of the annotation (text + arrow).
    • align ( enumerated : "left" | "center" | "right" )
      default: "center"
      Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans more two or more lines (i.e. `text` contains one or more <br> HTML tags) or if an explicit width is set to override the text width.
    • valign ( enumerated : "top" | "middle" | "bottom" )
      default: "middle"
      Sets the vertical alignment of the `text` within the box. Has an effect only if an explicit height is set to override the text height.
    • bgcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the background color of the annotation.
    • bordercolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color of the border enclosing the annotation `text`.
    • borderpad (number greater than or equal to 0)
      default: 1
      Sets the padding (in px) between the `text` and the enclosing border.
    • borderwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the border enclosing the annotation `text`.
    • showarrow (boolean)
      default: TRUE
      Determines whether or not the annotation is drawn with an arrow. If "TRUE", `text` is placed near the arrow's tail. If "FALSE", `text` lines up with the `x` and `y` provided.
    • arrowcolor (color)
      Sets the color of the annotation arrow.
    • arrowhead (integer between or equal to 0 and 8)
      default: 1
      Sets the end annotation arrow head style.
    • startarrowhead (integer between or equal to 0 and 8)
      default: 1
      Sets the start annotation arrow head style.
    • arrowside (flaglist string)
      Any combination of "end", "start" joined with a "+" OR "none".
      examples: "end", "start", "end+start", "none"
      default: "end"
      Sets the annotation arrow head position.
    • arrowsize (number greater than or equal to 0.3)
      default: 1
      Sets the size of the end annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.
    • startarrowsize (number greater than or equal to 0.3)
      default: 1
      Sets the size of the start annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.
    • arrowwidth (number greater than or equal to 0.1)
      Sets the width (in px) of annotation arrow line.
    • standoff (number greater than or equal to 0)
      default: 0
      Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.
    • startstandoff (number greater than or equal to 0)
      default: 0
      Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.
    • ax (number or categorical coordinate string)
      Sets the x component of the arrow tail about the arrow head. If `axref` is `pixel`, a positive (negative) component corresponds to an arrow pointing from right to left (left to right). If `axref` is an axis, this is an absolute value on that axis, like `x`, NOT a relative value.
    • ay (number or categorical coordinate string)
      Sets the y component of the arrow tail about the arrow head. If `ayref` is `pixel`, a positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom). If `ayref` is an axis, this is an absolute value on that axis, like `y`, NOT a relative value.
    • axref ( enumerated : "pixel" | "/^x([2-9]|[1-9][0-9]+)?$/" )
      default: "pixel"
      Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ax` is a relative offset in pixels from `x`. If set to an x axis id (e.g. "x" or "x2"), `ax` is specified in the same terms as that axis. This is useful for trendline annotations which should continue to indicate the correct trend when zoomed.
    • ayref ( enumerated : "pixel" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      default: "pixel"
      Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ay` is a relative offset in pixels from `y`. If set to a y axis id (e.g. "y" or "y2"), `ay` is specified in the same terms as that axis. This is useful for trendline annotations which should continue to indicate the correct trend when zoomed.
    • xref ( enumerated : "paper" | "/^x([2-9]|[1-9][0-9]+)?$/" )
      Sets the annotation's x coordinate axis. If set to an x axis id (e.g. "x" or "x2"), the `x` position refers to an x coordinate If set to "paper", the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right) side.
    • x (number or categorical coordinate string)
      Sets the annotation's x position. If the axis `type` is "log", then you must take the log of your desired range. If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
    • xanchor ( enumerated : "auto" | "left" | "center" | "right" )
      default: "auto"
      Sets the text box's horizontal position anchor This anchor binds the `x` position to the "left", "center" or "right" of the annotation. For example, if `x` is set to 1, `xref` to "paper" and `xanchor` to "right" then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If "auto", the anchor is equivalent to "center" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.
    • xshift (number)
      default: 0
      Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.
    • yref ( enumerated : "paper" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      Sets the annotation's y coordinate axis. If set to an y axis id (e.g. "y" or "y2"), the `y` position refers to an y coordinate If set to "paper", the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top).
    • y (number or categorical coordinate string)
      Sets the annotation's y position. If the axis `type` is "log", then you must take the log of your desired range. If the axis `type` is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
    • yanchor ( enumerated : "auto" | "top" | "middle" | "bottom" )
      default: "auto"
      Sets the text box's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the annotation. For example, if `y` is set to 1, `yref` to "paper" and `yanchor` to "top" then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If "auto", the anchor is equivalent to "middle" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.
    • yshift (number)
      default: 0
      Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.
    • clicktoshow ( enumerated : FALSE | "onoff" | "onout" )
      Makes this annotation respond to clicks on the plot. If you click a data point that exactly matches the `x` and `y` values of this annotation, and it is hidden (visible: FALSE), it will appear. In "onoff" mode, you must click the same point again to make it disappear, so if you click multiple points, you can show multiple annotations. In "onout" mode, a click anywhere else in the plot (on another data point or not) will hide this annotation. If you need to show/hide this annotation in response to different `x` or `y` values, you can set `xclick` and/or `yclick`. This is useful for example to label the side of a bar. To label markers though, `standoff` is preferred over `xclick` and `yclick`.
    • xclick (number or categorical coordinate string)
      Toggle this annotation when clicking a data point whose `x` value is `xclick` rather than the annotation's `x` value.
    • yclick (number or categorical coordinate string)
      Toggle this annotation when clicking a data point whose `y` value is `yclick` rather than the annotation's `y` value.
    • hovertext (string)
      Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear.
    • hoverlabel
      • bgcolor (color)
        Sets the background color of the hover label. By default uses the annotation's `bgcolor` made opaque, or white if it was transparent.
      • bordercolor (color)
        Sets the border color of the hover label. By default uses either dark grey or white, for maximum contrast with `hoverlabel.bgcolor`.
      • font
        Sets the hover label text font. By default uses the global hover font and size, with color from `hoverlabel.bordercolor`.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
    • captureevents (boolean)
      Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation. By default `captureevents` is "FALSE" unless `hovertext` is provided. If you use the event `plotly_clickannotation` without `hovertext` you must explicitly enable `captureevents`.
    • name (string)
      When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
    • templateitemname (string)
      Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
  • shapes
    Each named list has one or more of the keys listed below.
    • visible (boolean)
      default: TRUE
      Determines whether or not this shape is visible.
    • type ( enumerated : "circle" | "rect" | "path" | "line" )
      Specifies the shape type to be drawn. If "line", a line is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect to the axes' sizing mode. If "circle", a circle is drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with respect to the axes' sizing mode. If "rect", a rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to the axes' sizing mode. If "path", draw a custom SVG path using `path`. with respect to the axes' sizing mode.
    • layer ( enumerated : "below" | "above" )
      default: "above"
      Specifies whether shapes are drawn below or above traces.
    • xref ( enumerated : "paper" | "/^x([2-9]|[1-9][0-9]+)?$/" )
      Sets the shape's x coordinate axis. If set to an x axis id (e.g. "x" or "x2"), the `x` position refers to an x coordinate. If set to "paper", the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where "0" ("1") corresponds to the left (right) side. If the axis `type` is "log", then you must take the log of your desired range. If the axis `type` is "date", then you must convert the date to unix time in milliseconds.
    • xsizemode ( enumerated : "scaled" | "pixel" )
      default: "scaled"
      Sets the shapes's sizing mode along the x axis. If set to "scaled", `x0`, `x1` and x coordinates within `path` refer to data values on the x axis or a fraction of the plot area's width (`xref` set to "paper"). If set to "pixel", `xanchor` specifies the x position in terms of data or plot fraction but `x0`, `x1` and x coordinates within `path` are pixels relative to `xanchor`. This way, the shape can have a fixed width while maintaining a position relative to data or plot fraction.
    • xanchor (number or categorical coordinate string)
      Only relevant in conjunction with `xsizemode` set to "pixel". Specifies the anchor point on the x axis to which `x0`, `x1` and x coordinates within `path` are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when `xsizemode` not set to "pixel".
    • x0 (number or categorical coordinate string)
      Sets the shape's starting x position. See `type` and `xsizemode` for more info.
    • x1 (number or categorical coordinate string)
      Sets the shape's end x position. See `type` and `xsizemode` for more info.
    • yref ( enumerated : "paper" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      Sets the annotation's y coordinate axis. If set to an y axis id (e.g. "y" or "y2"), the `y` position refers to an y coordinate If set to "paper", the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where "0" ("1") corresponds to the bottom (top).
    • ysizemode ( enumerated : "scaled" | "pixel" )
      default: "scaled"
      Sets the shapes's sizing mode along the y axis. If set to "scaled", `y0`, `y1` and y coordinates within `path` refer to data values on the y axis or a fraction of the plot area's height (`yref` set to "paper"). If set to "pixel", `yanchor` specifies the y position in terms of data or plot fraction but `y0`, `y1` and y coordinates within `path` are pixels relative to `yanchor`. This way, the shape can have a fixed height while maintaining a position relative to data or plot fraction.
    • yanchor (number or categorical coordinate string)
      Only relevant in conjunction with `ysizemode` set to "pixel". Specifies the anchor point on the y axis to which `y0`, `y1` and y coordinates within `path` are relative to. E.g. useful to attach a pixel sized shape to a certain data value. No effect when `ysizemode` not set to "pixel".
    • y0 (number or categorical coordinate string)
      Sets the shape's starting y position. See `type` and `ysizemode` for more info.
    • y1 (number or categorical coordinate string)
      Sets the shape's end y position. See `type` and `ysizemode` for more info.
    • path (string)
      For `type` "path" - a valid SVG path with the pixel values replaced by data values in `xsizemode`/`ysizemode` being "scaled" and taken unmodified as pixels relative to `xanchor` and `yanchor` in case of "pixel" size mode. There are a few restrictions / quirks only absolute instructions, not relative. So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs (A) are not allowed because radius rx and ry are relative. In the future we could consider supporting relative commands, but we would have to decide on how to handle date and log axes. Note that even as is, Q and C Bezier paths that are smooth on linear axes may not be smooth on log, and vice versa. no chained "polybezier" commands - specify the segment type for each one. On category axes, values are numbers scaled to the serial numbers of categories because using the categories themselves there would be no way to describe fractional positions On data axes: because space and T are both normal components of path strings, we can't use either to separate date from time parts. Therefore we'll use underscore for this purpose: 2015-02-21_13:45:56.789
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the opacity of the shape.
    • line
      • color (color)
        Sets the line color.
      • width (number greater than or equal to 0)
        default: 2
        Sets the line width (in px).
      • dash (string)
        default: "solid"
        Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
    • fillcolor (color)
      default: "rgba(0,0,0,0)"
      Sets the color filling the shape's interior.
    • name (string)
      When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
    • templateitemname (string)
      Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
  • images
    Each named list has one or more of the keys listed below.
    • visible (boolean)
      default: TRUE
      Determines whether or not this image is visible.
    • source (string)
      Specifies the URL of the image to be used. The URL must be accessible from the domain where the plot code is run, and can be either relative or absolute.
    • layer ( enumerated : "below" | "above" )
      default: "above"
      Specifies whether images are drawn below or above traces. When `xref` and `yref` are both set to `paper`, image is drawn below the entire plot area.
    • sizex (number)
      default: 0
      Sets the image container size horizontally. The image will be sized based on the `position` value. When `xref` is set to `paper`, units are sized relative to the plot width.
    • sizey (number)
      default: 0
      Sets the image container size vertically. The image will be sized based on the `position` value. When `yref` is set to `paper`, units are sized relative to the plot height.
    • sizing ( enumerated : "fill" | "contain" | "stretch" )
      default: "contain"
      Specifies which dimension of the image to constrain.
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the opacity of the image.
    • x (number or categorical coordinate string)
      default: 0
      Sets the image's x position. When `xref` is set to `paper`, units are sized relative to the plot height. See `xref` for more info
    • y (number or categorical coordinate string)
      default: 0
      Sets the image's y position. When `yref` is set to `paper`, units are sized relative to the plot height. See `yref` for more info
    • xanchor ( enumerated : "left" | "center" | "right" )
      default: "left"
      Sets the anchor for the x position
    • yanchor ( enumerated : "top" | "middle" | "bottom" )
      default: "top"
      Sets the anchor for the y position.
    • xref ( enumerated : "paper" | "/^x([2-9]|[1-9][0-9]+)?$/" )
      default: "paper"
      Sets the images's x coordinate axis. If set to a x axis id (e.g. "x" or "x2"), the `x` position refers to an x data coordinate If set to "paper", the `x` position refers to the distance from the left of plot in normalized coordinates where "0" ("1") corresponds to the left (right).
    • yref ( enumerated : "paper" | "/^y([2-9]|[1-9][0-9]+)?$/" )
      default: "paper"
      Sets the images's y coordinate axis. If set to a y axis id (e.g. "y" or "y2"), the `y` position refers to a y data coordinate. If set to "paper", the `y` position refers to the distance from the bottom of the plot in normalized coordinates where "0" ("1") corresponds to the bottom (top).
    • name (string)
      When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
    • templateitemname (string)
      Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
  • updatemenus
    Each named list has one or more of the keys listed below.
    • _arrayAttrRegexps
    • visible (boolean)
      Determines whether or not the update menu is visible.
    • type ( enumerated : "dropdown" | "buttons" )
      default: "dropdown"
      Determines whether the buttons are accessible via a dropdown menu or whether the buttons are stacked horizontally or vertically
    • direction ( enumerated : "left" | "right" | "up" | "down" )
      default: "down"
      Determines the direction in which the buttons are laid out, whether in a dropdown menu or a row/column of buttons. For `left` and `up`, the buttons will still appear in left-to-right or top-to-bottom order respectively.
    • active (integer greater than or equal to -1)
      default: 0
      Determines which button (by index starting from 0) is considered active.
    • showactive (boolean)
      default: TRUE
      Highlights active dropdown item or active button if TRUE.
    • buttons
      Each named list has one or more of the keys listed below.
      • visible (boolean)
        Determines whether or not this button is visible.
      • method ( enumerated : "restyle" | "relayout" | "animate" | "update" | "skip" )
        default: "restyle"
        Sets the Plotly method to be called on click. If the `skip` method is used, the API updatemenu will function as normal but will perform no API calls and will not bind automatically to state updates. This may be used to create a component interface and attach to updatemenu events manually via JavaScript.
      • args (list)
        Sets the arguments values to be passed to the Plotly method set in `method` on click.
      • label (string)
        default: ""
        Sets the text label to appear on the button.
      • execute (boolean)
        default: TRUE
        When TRUE, the API method is executed. When FALSE, all other behaviors are the same and command execution is skipped. This may be useful when hooking into, for example, the `plotly_buttonclicked` method and executing the API command manually without losing the benefit of the updatemenu automatically binding to the state of the plot through the specification of `method` and `args`.
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • x (number between or equal to -2 and 3)
      default: -0.05
      Sets the x position (in normalized coordinates) of the update menu.
    • xanchor ( enumerated : "auto" | "left" | "center" | "right" )
      default: "right"
      Sets the update menu's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the range selector.
    • y (number between or equal to -2 and 3)
      default: 1
      Sets the y position (in normalized coordinates) of the update menu.
    • yanchor ( enumerated : "auto" | "top" | "middle" | "bottom" )
      default: "top"
      Sets the update menu's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the range selector.
    • pad
      Sets the padding around the buttons or dropdown menu.
      • t (number)
        default: 0
        The amount of padding (in px) along the top of the component.
      • r (number)
        default: 0
        The amount of padding (in px) on the right side of the component.
      • b (number)
        default: 0
        The amount of padding (in px) along the bottom of the component.
      • l (number)
        default: 0
        The amount of padding (in px) on the left side of the component.
    • font
      Sets the font of the update menu button text.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • bgcolor (color)
      Sets the background color of the update menu buttons.
    • bordercolor (color)
      default: "#BEC8D9"
      Sets the color of the border enclosing the update menu.
    • borderwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the border enclosing the update menu.
    • name (string)
      When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
    • templateitemname (string)
      Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
  • sliders
    Each named list has one or more of the keys listed below.
    • visible (boolean)
      default: TRUE
      Determines whether or not the slider is visible.
    • active (number greater than or equal to 0)
      default: 0
      Determines which button (by index starting from 0) is considered active.
    • steps
      Each named list has one or more of the keys listed below.
      • visible (boolean)
        default: TRUE
        Determines whether or not this step is included in the slider.
      • method ( enumerated : "restyle" | "relayout" | "animate" | "update" | "skip" )
        default: "restyle"
        Sets the Plotly method to be called when the slider value is changed. If the `skip` method is used, the API slider will function as normal but will perform no API calls and will not bind automatically to state updates. This may be used to create a component interface and attach to slider events manually via JavaScript.
      • args (list)
        Sets the arguments values to be passed to the Plotly method set in `method` on slide.
      • label (string)
        Sets the text label to appear on the slider
      • value (string)
        Sets the value of the slider step, used to refer to the step programatically. Defaults to the slider label if not provided.
      • execute (boolean)
        default: TRUE
        When TRUE, the API method is executed. When FALSE, all other behaviors are the same and command execution is skipped. This may be useful when hooking into, for example, the `plotly_sliderchange` method and executing the API command manually without losing the benefit of the slider automatically binding to the state of the plot through the specification of `method` and `args`.
      • name (string)
        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
      • templateitemname (string)
        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
    • lenmode ( enumerated : "fraction" | "pixels" )
      default: "fraction"
      Determines whether this slider length is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the slider This measure excludes the padding of both ends. That is, the slider's length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 0
      Sets the x position (in normalized coordinates) of the slider.
    • pad
      Set the padding of the slider component along each side.
      • t (number)
        default: 20
        The amount of padding (in px) along the top of the component.
      • r (number)
        default: 0
        The amount of padding (in px) on the right side of the component.
      • b (number)
        default: 0
        The amount of padding (in px) along the bottom of the component.
      • l (number)
        default: 0
        The amount of padding (in px) on the left side of the component.
    • xanchor ( enumerated : "auto" | "left" | "center" | "right" )
      default: "left"
      Sets the slider's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the range selector.
    • y (number between or equal to -2 and 3)
      default: 0
      Sets the y position (in normalized coordinates) of the slider.
    • yanchor ( enumerated : "auto" | "top" | "middle" | "bottom" )
      default: "top"
      Sets the slider's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the range selector.
    • transition
      • duration (number greater than or equal to 0)
        default: 150
        Sets the duration of the slider transition
      • easing ( enumerated : "linear" | "quad" | "cubic" | "sin" | "exp" | "circle" | "elastic" | "back" | "bounce" | "linear-in" | "quad-in" | "cubic-in" | "sin-in" | "exp-in" | "circle-in" | "elastic-in" | "back-in" | "bounce-in" | "linear-out" | "quad-out" | "cubic-out" | "sin-out" | "exp-out" | "circle-out" | "elastic-out" | "back-out" | "bounce-out" | "linear-in-out" | "quad-in-out" | "cubic-in-out" | "sin-in-out" | "exp-in-out" | "circle-in-out" | "elastic-in-out" | "back-in-out" | "bounce-in-out" )
        default: "cubic-in-out"
        Sets the easing function of the slider transition
    • currentvalue
      • visible (boolean)
        default: TRUE
        Shows the currently-selected value above the slider.
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        The alignment of the value readout relative to the length of the slider.
      • offset (number)
        default: 10
        The amount of space, in pixels, between the current value label and the slider.
      • prefix (string)
        When currentvalue.visible is TRUE, this sets the prefix of the label.
      • suffix (string)
        When currentvalue.visible is TRUE, this sets the suffix of the label.
      • font
        Sets the font of the current value label text.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
    • font
      Sets the font of the slider step labels.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
      • size (number greater than or equal to 1)
      • color (color)
    • activebgcolor (color)
      default: "#dbdde0"
      Sets the background color of the slider grip while dragging.
    • bgcolor (color)
      default: "#f8fafc"
      Sets the background color of the slider.
    • bordercolor (color)
      default: "#bec8d9"
      Sets the color of the border enclosing the slider.
    • borderwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the border enclosing the slider.
    • ticklen (number greater than or equal to 0)
      default: 7
      Sets the length in pixels of step tick marks
    • tickcolor (color)
      default: "#333"
      Sets the color of the border enclosing the slider.
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • minorticklen (number greater than or equal to 0)
      default: 4
      Sets the length in pixels of minor step tick marks
    • name (string)
      When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
    • templateitemname (string)
      Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
  • colorscale
    • sequential (colorscale)
      default: 0rgb(220,220,220)0.2rgb(245,195,157)0.4rgb(245,160,105)1rgb(178,10,28)
      Sets the default sequential colorscale for positive values. Note that `autocolorscale` must be TRUE for this attribute to work.
    • sequentialminus (colorscale)
      default: 0rgb(5,10,172)0.35rgb(40,60,190)0.5rgb(70,100,245)0.6rgb(90,120,245)0.7rgb(106,137,247)1rgb(220,220,220)
      Sets the default sequential colorscale for negative values. Note that `autocolorscale` must be TRUE for this attribute to work.
    • diverging (colorscale)
      default: 0rgb(5,10,172)0.35rgb(106,137,247)0.5rgb(190,190,190)0.6rgb(220,170,132)0.7rgb(230,145,90)1rgb(178,10,28)
      Sets the default diverging colorscale. Note that `autocolorscale` must be TRUE for this attribute to work.
  • coloraxis
    • cauto (boolean)
      default: TRUE
      Determines whether or not the color domain is computed with respect to the input data (here corresponding trace color array(s)) or the bounds set in `cmin` and `cmax` Defaults to `FALSE` when `cmin` and `cmax` are set by the user.
    • cmin (number)
      Sets the lower bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, `cmax` must be set as well.
    • cmax (number)
      Sets the upper bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, `cmin` must be set as well.
    • cmid (number)
      Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as corresponding trace color array(s). Has no effect when `cauto` is `FALSE`.
    • colorscale (colorscale)
      Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
    • autocolorscale (boolean)
      default: TRUE
      Determines whether the colorscale is a default palette (`autocolorscale: TRUE`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is TRUE, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
    • reversescale (boolean)
      Reverses the color mapping if TRUE. If TRUE, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.
    • showscale (boolean)
      default: TRUE
      Determines whether or not a colorbar is displayed for this trace.
    • colorbar
      • thicknessmode ( enumerated : "fraction" | "pixels" )
        default: "pixels"
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode ( enumerated : "fraction" | "pixels" )
        default: "fraction"
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor ( enumerated : "left" | "center" | "right" )
        default: "left"
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor ( enumerated : "top" | "middle" | "bottom" )
        default: "middle"
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: "#444"
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: "#444"
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: "rgba(0,0,0,0)"
        Sets the color of padded area.
      • tickmode ( enumerated : "auto" | "linear" | "array" )
        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
      • tick0 (number or categorical coordinate string)
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
      • dtick (number or categorical coordinate string)
        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"
      • tickvals (dataframe column, list, vector)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
      • ticktext (dataframe column, list, vector)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
      • ticks ( enumerated : "outside" | "inside" | "" )
        default: ""
        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: "#444"
        Sets the tick color.
      • showticklabels (boolean)
        default: TRUE
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the color bar's tick label font
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ""
        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
      • tickformatstops
        Each named list has one or more of the keys listed below.
        • enabled (boolean)
          default: TRUE
          Determines whether or not this stop is used. If `FALSE`, this stop is ignored even within its `dtickrange`.
        • dtickrange (list)
          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"
        • value (string)
          default: ""
          string - dtickformat for described zoom level, the same as "tickformat"
        • name (string)
          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). Has no effect outside of a template.
        • templateitemname (string)
          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: FALSE` or `enabled: FALSE` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: TRUE`.
      • tickprefix (string)
        default: ""
        Sets a tick label prefix.
      • showtickprefix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
      • ticksuffix (string)
        default: ""
        Sets a tick label suffix.
      • showticksuffix ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        Same as `showtickprefix` but for tick suffixes.
      • separatethousands (boolean)
        If "TRUE", even 4-digit integers are separated
      • exponentformat ( enumerated : "none" | "e" | "E" | "power" | "SI" | "B" )
        default: "B"
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
      • showexponent ( enumerated : "all" | "first" | "last" | "none" )
        default: "all"
        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
      • title
        • text (string)
          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.
        • font
          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.
          • family (string)
            HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".
          • size (number greater than or equal to 1)
          • color (color)
        • side ( enumerated : "right" | "top" | "bottom" )
          default: "top"
          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.
      • tickvalssrc
      • ticktextsrc
  • metasrc
  • boxmode ( enumerated : "group" | "overlay" )
    default: "overlay"
    Determines how boxes at the same location coordinate are displayed on the graph. If "group", the boxes are plotted next to one another centered around the shared location. If "overlay", the boxes are plotted over one another, you might need to set "opacity" to see them multiple boxes. Has no effect on traces that have "width" set.
  • boxgap (number between or equal to 0 and 1)
    default: 0.3
    Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have "width" set.
  • boxgroupgap (number between or equal to 0 and 1)
    default: 0.3
    Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set.
  • barmode ( enumerated : "stack" | "group" | "overlay" | "relative" )
    default: "group"
    Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "relative", the bars are stacked on top of one another, with negative values below the axis, positive values above With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars.
  • barnorm ( enumerated : "" | "fraction" | "percent" )
    default: ""
    Sets the normalization for bar traces on the graph. With "fraction", the value of each bar is divided by the sum of all values at that location coordinate. "percent" is the same but multiplied by 100 to show percentages.
  • bargap (number between or equal to 0 and 1)
    Sets the gap (in plot fraction) between bars of adjacent location coordinates.
  • bargroupgap (number between or equal to 0 and 1)
    default: 0
    Sets the gap (in plot fraction) between bars of the same location coordinate.
  • violinmode ( enumerated : "group" | "overlay" )
    default: "overlay"
    Determines how violins at the same location coordinate are displayed on the graph. If "group", the violins are plotted next to one another centered around the shared location. If "overlay", the violins are plotted over one another, you might need to set "opacity" to see them multiple violins. Has no effect on traces that have "width" set.
  • violingap (number between or equal to 0 and 1)
    default: 0.3
    Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have "width" set.
  • violingroupgap (number between or equal to 0 and 1)
    default: 0.3
    Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have "width" set.
  • waterfallmode ( enumerated : "group" | "overlay" )
    default: "group"
    Determines how bars at the same location coordinate are displayed on the graph. With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars.
  • waterfallgap (number between or equal to 0 and 1)
    Sets the gap (in plot fraction) between bars of adjacent location coordinates.
  • waterfallgroupgap (number between or equal to 0 and 1)
    default: 0
    Sets the gap (in plot fraction) between bars of the same location coordinate.
  • hiddenlabels (dataframe column, list, vector)
    hiddenlabels is the funnelarea & pie chart analog of visible:'legendonly' but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts
  • piecolorway (colorlist)
    Sets the default pie slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendpiecolors`.
  • extendpiecolors (boolean)
    default: TRUE
    If `TRUE`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `FALSE` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
  • hiddenlabelssrc
  • sunburstcolorway (colorlist)
    Sets the default sunburst slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendsunburstcolors`.
  • extendsunburstcolors (boolean)
    default: TRUE
    If `TRUE`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `FALSE` to disable. Colors provided in the trace, using `marker.colors`, are never extended.